Add contributing guidelines to CONTRIBUTING.md #4
Conversation
Added guidelines for contributing to the project, including steps for submitting a pull request and resources for contributors.
There was a problem hiding this comment.
Pull request overview
Adds a CONTRIBUTING.md document to provide contributors with guidance on how to submit changes and where to find helpful resources.
Changes:
- Introduces a new contributing guide with a pull request workflow checklist.
- Adds reference links for forking, opening PRs, and external contribution resources.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great. | ||
|
|
||
| Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [project's open source license](LICENSE.txt). |
There was a problem hiding this comment.
The link to the project license points to LICENSE.txt, but this repository’s license file is LICENSE (no .txt). Update the link so it resolves correctly.
|
|
||
| Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [project's open source license](LICENSE.txt). | ||
|
|
||
| Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms. |
There was a problem hiding this comment.
CODE_OF_CONDUCT.md is referenced here but does not exist in the repository, so the link is broken. Either add a Code of Conduct file at that path or update the link to the correct location (e.g., if it lives under .github/).
| Here are a few things you can do that will increase the likelihood of your pull request being accepted: | ||
|
|
||
| - Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests. | ||
| - Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). |
There was a problem hiding this comment.
This external link uses plain HTTP. Consider switching to HTTPS to avoid mixed-content/security warnings and to match modern documentation standards (if the site supports it).
| - Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). | |
| - Write a [good commit message](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). |
Added guidelines for contributing to the project, including steps for submitting a pull request and resources for contributors.