Skip to content

Latest commit

 

History

History
57 lines (36 loc) · 3.98 KB

CONTRIBUTING.md

File metadata and controls

57 lines (36 loc) · 3.98 KB
Raw

###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.

Starter Bugs

If you need some inspiration for a starter bug, we have some for you either as GitHub Issue or on the Trello Board (there, choose on the right hand sidebar "Filter Cards" and then click on "Starter Feature").

Getting Started

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.

  1. Please sign the Brackets Contributor License Agreement. You must agree to and submit this before you can contribute to Brackets.

  2. 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.

Making Changes

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:

  1. read the following wiki page on GitHub: https://github.com/adobe/brackets/wiki/How-to-Hack-on-Brackets.
  2. merge from adobe/brackets master
  3. re-test your code after the merge
  4. run the unit tests with Debug > Run Tests -- everything should pass
  5. if your change is nontrivial or might have affected the UI, run through the Brackets smoke tests and possibly the Brackets server smoke tests.
  6. review the Pull Request Checklist for additional guidance.

Reviewing Code, Committing

In general code reviews can be performed by anyone who knows his/her limits, is familiar with the feature area and the architecture, where the code, being reviewed, is added or altered. To submit changes one needs commit rights - those are limited to ensure sustainable high quality. Committers are tasked with taking a leading role in the project by making code contributions, assisting others with their contributions in the form of reviewing and merging pull requests, and providing feedback and suggestions on the direction of the project.

Please refer to the Committer Policy for more information. If you want to perform reviews, but don't have commit rights yet, we encourage you to do so. Please add a note that you start reviewing. After you have finished your review ping us at IRC or leave a comment that your review has been completed. A committer will submit the pull request based on priority. If a pull request already shows an assignee, please check with him/her first.

##Additional Resources