Skip to content

Latest commit

 

History

History
61 lines (31 loc) · 3.06 KB

CONTRIBUTING.md

File metadata and controls

61 lines (31 loc) · 3.06 KB

Contributing to [Project Name]

Welcome to [Project Name]! We are thrilled that you are interested in contributing to our open-source project. By following these guidelines, you can help us maintain a collaborative and productive community. Thank you for your contributions!

Code of Conduct

We expect all contributors to follow our Code of Conduct. Please ensure a friendly and inclusive environment within the community.

How to Contribute

Reporting Issues

If you encounter any bugs, have feature requests, or other concerns, please open an issue on the Issue Tracker. Please ensure that your issue is not already reported to avoid duplicates.

When creating an issue, provide a clear and detailed description of the problem or request. Include relevant information such as steps to reproduce, the expected behavior, and the actual behavior. Screenshots or code examples can be helpful too.

Making Changes

  1. Fork the repository to your GitHub account.

  2. Create a new branch from the main branch for your work. Use a descriptive name for the branch, such as feature/new-feature or bugfix/issue-number.

  3. Make the necessary changes to the codebase. Follow the Coding Standards and ensure your code is well-documented.

  4. Write tests to cover your changes, if applicable. Ensure that all existing tests pass.

  5. Commit your changes with clear and concise commit messages.

  6. Push your branch to your forked repository.

  7. Create a Pull Request (PR) against the main branch of the original repository. Use a descriptive title and provide a detailed description of the changes in the PR description.

  8. Request a review from other contributors. Address any feedback or comments during the review process.

Code Review

Code reviews are essential to maintain code quality and consistency. Be open to feedback and use the review process to learn from other contributors. Ensure that your code adheres to the Coding Standards and passes all tests before requesting a review.

Branching Strategy

We use Branching Strategy for development. Please familiarize yourself with the workflow before creating branches and PRs.

Coding Standards

Follow the Coding Standards to ensure consistency in the codebase. We use linters to enforce these standards automatically.

Testing

All code changes should include tests that cover the changes made. Ensure that your tests pass before submitting a PR.

License Agreement

By contributing to this project, you agree that your contributions will be subject to the MIT License attached to this repository.

Community Engagement

We encourage positive and respectful communication within the community. Engage in discussions, respond to issues and PRs, and help other contributors as needed.

Thank you for your interest in contributing to [Project Name]. Your contributions are valuable to us, and together, we can build an amazing open-source project!

Happy coding! 🚀