We appreciate any community contributions to this project, whether in the form of issues or Pull Requests.
This document outlines what we'd like you to follow in terms of commit messages and code style.
It also explains what to do in case you want to set up the project locally.
If you have any questions or concerns please reach out to us either by filing an issue in the relevant repository or posting in the Contentful Community Slack.
Before creating a new issue; please check out the open issues as someone might have already created one for you! Please use the recommended templates for each section as helps us resolve issues faster.
Bugs are tracked as GitHub issues. If you are sure there's currently not an issue that describes the bug you're experiencing, create an issue on the repository and provide the following information by filling in the template.
Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
Want to make an enhancement proposal, including completely new features and minor improvements to existing functionality? Please create an issue with the proposal template.
Not experiencing a bug or wanting to make a proposal, but still want to reach out? A lot of our colleagues are hanging out in Contentful Community Slack and might be able to help. Can't find your answer there? You can file a feedback issue through this template.
The process described here has several goals:
- Maintain the quality of the repository
- Fix problems that are important to users
- Enable a sustainable system for the maintainers from Contentful to review contributions
Please follow these steps to have your contribution considered by the maintainers:
- Follow all instructions in the template
- After you submit your pull request, verify that all status checks are passing
What if the status checks are failing?
If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, then we will open an issue to track that problem with our status check suite.
While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.