Skip to content

Latest commit

 

History

History
85 lines (59 loc) · 4.48 KB

CONTRIBUTING.md

File metadata and controls

85 lines (59 loc) · 4.48 KB
Raw

Contributing to Node Healthcheck

First of all, thank you for considering to contribute to Node Healthcheck! Your help is invaluable to improve the project and make it more useful for the community. This document will guide you through the contribution process and make it easier for you to get started.

Table of Contents

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. Please read it to ensure a welcoming and inclusive environment for all contributors.

How to Contribute

Reporting Bugs

If you find a bug, please create a new issue in the issue tracker. When submitting a bug report, please include:

  • A clear and descriptive title.
  • A detailed description of the issue, including the steps to reproduce the bug.
  • Screenshots, if applicable, to help demonstrate the problem.
  • The version of the project you are using, as well as any other relevant information (e.g., operating system, browser, etc.).

Suggesting Enhancements

If you have an idea for a new feature or improvement, please create a new issue in the issue tracker. When suggesting an enhancement, please include:

  • A clear and descriptive title.
  • A detailed description of the proposed feature, including examples of how it should work.
  • Any relevant use cases or benefits of the proposed enhancement.

Pull Requests

If you would like to contribute code, documentation, or other assets to the project, please submit a pull request. When submitting a pull request, please:

  • Ensure that your code follows the Style Guide.
  • Provide a clear and descriptive title.
  • Include a description of the changes you made and their purpose.
  • Reference any related issues or pull requests, if applicable.
  • Make sure your code passes any tests and linters that the project uses.
  • Update any relevant documentation or comments.

How to submit a pull request

  1. Fork the repository on GitHub.
  2. Clone your fork to your local machine.
  3. Create a new branch for your feature or bugfix based on the main branch.
    1. Use git checkout -b feature/your-feature-name for features.
    2. Use git checkout -b bugfix/your-bugfix-name for bugfixes.
  4. Make your changes and commit them to your new branch.
  5. Push your changes to your fork.
  6. Open a pull request against the main branch of the original repository.

ℹ️ Tip: Write your commit messages following the git guidelines. Use present tense and imperative verbs, e.g. "Fix bug" and not "Fixed bug" or "Fixes bug.". Your commit message should describe what the commit, when applied, does to the code – not what you did to the code.

Style Guide

Please adhere to the project's coding style and conventions when contributing. This may include:

  • Code formatting (e.g., indentation, line length, etc.).
  • Naming conventions for variables, functions, classes, etc.
  • Commenting guidelines, including when and how to write comments.
  • Test-writing guidelines, including test coverage requirements.

If the project uses a specific code formatter or linter, please ensure your contributions pass these checks before submitting a pull request.

Additional Resources

Once again, thank you for your interest in contributing to Node Healthcheck! Your support and collaboration are crucial to the success and growth of this project. If you have any questions or need additional guidance, please don't hesitate to reach out to the maintainers.

Happy coding!