- Create a fork in GitHub
- Make sure that there is a corresponding issue for your change first. If there is none, create one.
- Create a
...
- branch off the
masterbranch. Name it something that that makes sense,
...
- and add the JIRA Issue Id as part of the name. For example DATASTD-146 Peer Rating table. This makes it easy for everyone to figure out what the branch is used for. It also makes it easier to isolate your change from incoming changes from the origin.
- Commit your changes and push your changes to GitHub.
- Create a pull request against the origin's
masterbranch
...
- . Make sure the pull request includes the JIRA Issue Id, for example DASH
-681 Remove white space in Learning Standards Drilldown. For more details on how to submit a pull request How To: Submit a Pull Request.
| Info |
|---|
We use JIRA smart commits, smart commits only support the default JIRA issue key format. This format is two or more uppercase letters, followed by a hyphen and the issue number, for our projects we have the following: DASH-131 ETL-1234 DATASTD-124 Users can include multiple smart commits directives in the same commit message. For more details see: Processing JIRA Issues with commit messages. |
DOs and DON'Ts
- DO follow our coding style (see below)
- DO include tests when adding new features. When fixing bugs, start with adding a test that highlights how the current behavior is broken.
- DO keep the discussions focused. When a new or related topic comes up it's often better to create new issue than to side track the discussion.
- DON'T surprise us with big pull requests. Instead, file an issue and start a discussion so we can agree on a direction before you invest a large amount of time.
...