Curious to start contributing to Brackets?
With this file we want to provide some general guidance how to contribute to Brackets - your feedback is very welcome.
Issues starting Brackets the first time? Please review the Troubleshooting Page.
Before you start coding, post to the brackets-dev Google group or the #brackets IRC channel on freenode about what you're thinking of working on, so you can get early feedback. This also provides you with an opportunity to find out what others including the core team are working on.
Brackets is developed using Agile development methodologies, features are tracked as user stories on the public Brackets backlog. You may vote on existing stories or find stories to work on with others.
Please sign the Brackets Contributor License Agreement. You must agree to and submit this before you can contribute to Brackets.
Please collaborate with others in providing and receiving guidance; the Brackets team made it a priority to look at pull requests daily, however depending on the feature priority, the complexity of a contribution, and available bandwidth we may not be able to work on it right away.
If you use Brackets to edit Brackets, you can quickly reload the app itself by choosing Debug > Reload Brackets from the in-app menu. When coding, make sure to follow our coding conventions.
Before submitting any pull request, please make sure to:
- read the following wiki page on GitHub: https://github.com/adobe/brackets/wiki/How-to-Hack-on-Brackets.
- merge from adobe/brackets master
- re-test your code after the merge
- run the unit tests with Debug > Run Tests -- everything should pass
- if your change is nontrivial or might have affected the UI, run through the Brackets smoke tests and possibly the Brackets server smoke tests.
- review the Pull Request Checklist for additional guidance.