CONTRIBUTING.md Generator
Developed by ecstasy - member of Praxidike
Credit: paulmis
Result
You can see your markdown result here:
<!-- CONTRIBUTING RULES AND GUIDELINES WHEN DEVELOPING IN THIS REPOSITORY -->
# Welcome to GitHub docs contributing guide <!-- omit in toc -->
Thank you for intereset in contributing to our project!
Read our [Code of Conduct](CODE_OF_CONDUCT.md) to keep our community approachable and respectable.
In this guide you will get an overview of the contribution workflow. Changes made by your or your team will have to abide by the rules written here so make sure you carefully read this file.
## New Contributors
It is good to see new contributors who are eager to contribute to the open-source community. Make sure to first read our [README](README.md) first. In accordance with the GitHub's CONTRIBUTING guides, we list the following resources to help you begin contributing conventionally.
- [Finding ways to contribute to open source on GitHub](https://docs.github.com/en/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github)
- [Set up Git](https://docs.github.com/en/get-started/quickstart/set-up-git)
- [GitHub flow](https://docs.github.com/en/get-started/quickstart/github-flow)
- [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests)
**GitHub projects integration (for contributors):** Keep an eye on the GitHub project link to this repository to see whether the issue you have is already worked on, requires attention or help and what tasks can you contribute to.
Getting started
The idea for this template is taken from the [GitHub docs CONTRIBUTING.md](https://github.com/github/docs/blob/main/CONTRIBUTING.md)
### Issues
#### Create a new issue
If you spot a problem with this project, search if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue form.
#### Solve an issue
Scan through our existing issues to find one that interests you. You can narrow down the search using `labels` as filters. See Labels for more information. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.
### Commit your update
Commit the changes once you are happy with them. Don't forget to self-review to speed up the review process.Make sure that your commits follow the [CONVENTIONS.md](CONVENTIONS.md})
### Pull Request
When you're finished with the changes, create a pull request, also known as a PR.
- Fill the Pull Request template so that we can easily review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
- Link PR to issue if you are solving one.
- Once you submit your PR, a Docs team member will review your proposal. We may ask questions or request additional information.
- We may ask for changes to be made before a PR can be merged. Be ready to respond to any comments we might have.
- As you update your PR and apply changes, mark each conversation as resolved.
Create your CONTRIBUTING.md
include a link to your Code of Conduct
include credits to us on top of the document
include guides for newer contributors