Skip to content

Latest commit

 

History

History
49 lines (36 loc) · 2.42 KB

CONTRIBUTING.md

File metadata and controls

49 lines (36 loc) · 2.42 KB
Raw

Contributing Guidelines

Thank you for considering contributing to our project! We welcome contributions from anyone interested in improving the project. Before making a contribution, please take a moment to review the following guidelines.

Code of Conduct

Please review our Code of Conduct before contributing to ensure a positive and inclusive environment for everyone.

How to Contribute

  1. Fork the repository to your GitHub account.
  2. Clone the forked repository to your local machine: 
    git clone https://github.com/your-username/tooler-tools.git
  3. Create a new branch for your contribution: 
    git checkout -b feat/your-feature-name
  4. Make your changes and commit them with a descriptive commit message: 
    git commit -m 'feat(#001): Add a descriptive commit message'
  5. Push your changes to your fork: 
    git push origin feat/your-feature-name
  6. Open a pull request (PR) against the dev branch of the original repository. Please provide a clear title and description for your PR, explaining the purpose of the changes.

Contribution Guidelines

  • Coding Standards: Follow the coding standards and conventions used in the project. Ensure your code is well-formatted and easy to read.
  • Testing: Write tests to cover your code changes. Ensure existing tests pass before submitting a PR.
  • Documentation: Update relevant documentation, such as CHANGELOG.md or JavaDocs, to reflect your changes.
  • Commit Messages: Write clear and descriptive commit messages, following Conventional Commits format where applicable (optional).
  • Pull Request Reviews: Be open to feedback and willing to make changes if required during the PR review process.
  • License: Ensure your contributions comply with the project's license.

Reporting Issues

If you encounter any issues or have suggestions for improvements, please open an issue on GitHub and provide detailed information about the problem or suggestion.

Get in Touch

If you have any questions or need further assistance, feel free to reach out to us through GitHub issues or discussions.

Acknowledgements

We appreciate your interest in contributing to our project! Your help is invaluable in making this project better.