Skip to content

Commit

Permalink
init CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
HemantKArya authored Feb 11, 2024
1 parent ce90163 commit 4b2a6c0
Showing 1 changed file with 57 additions and 0 deletions.
57 changes: 57 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
How to Contribute

Fork the Repository: Click the "Fork" button in the top-right corner of the repository's page on GitHub, and clone your forked repository to your local machine.

Create a Branch: Before making any changes, create a new branch to work on. Choose a descriptive name for your branch that reflects the feature or fix you intend to make.

bash

Copy code

git checkout -b feature/new-feature

Make Changes: Make your desired changes to the codebase. Ensure that your changes adhere to the project's coding conventions and standards.

Commit Changes: Once you're satisfied with your changes, commit them to your branch with clear and concise commit messages.

bash

Copy code

git commit -m "Add feature: Description of the changes made"

Push Changes: Push your changes to your forked repository on GitHub.

bash

Copy code

git push origin feature/new-feature

Submit a Pull Request (PR): Go to the original repository and click on the "New Pull Request" button. Provide a descriptive title and description for your pull request, explaining the changes you've made.

Review and Discuss: Engage in discussions with maintainers and other contributors regarding your pull request. Be open to feedback and iterate on your changes if necessary.

Merge Pull Request: Once your pull request has been reviewed and approved, a maintainer will merge it into the main branch. Congratulations, your contribution has been accepted!

Code Style and Standards
Follow the existing code style and conventions used in the project.
Ensure your code is well-formatted, readable, and documented.
Write clear and concise commit messages.


Issues and Bug Reports

If you encounter a bug or have a suggestion for improvement, please search the existing issues to see if it has already been reported.
If not, feel free to open a new issue, providing as much detail as possible, including steps to reproduce the issue.


Community Guidelines

Be respectful and considerate of others' ideas, opinions, and contributions.
Help and support fellow contributors, especially beginners.
Avoid spamming, trolling, or engaging in any form of harassment.

License

By contributing to this project, you agree that your contributions will be licensed under the project's license.

0 comments on commit 4b2a6c0

Please sign in to comment.