Skip to content

Detail on documenting pull requests #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
incognos wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Detail on documenting pull requests #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions book/processes/github-create-pr.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,28 @@ to the github ui, find your branch, and click the "compare and create pull reque
and make sure you have not included anything by accident, and then write a detailed commit message describing the changes
implemented by your branch.

Pull Requests should be separated by concerns - meaning, if you are implementing fetures towards a specific milestone, only
commits related to that milestone should be included in your pull request.

Pull request commit messages should include a sane and descriptive first line message not longer than 70 characters, optionally
followed by a short description of the commit and a list of all issues worked on with their associated issue #.

----
Condition page layout and styling # <1>

Implemented page structure and styling accoring to # <2>
condition page guide provided

- Link Condition pages in search box - #215 # <3>
- Condition page images not showing on travis deploy - #213
- Karma tests #194
- css bug found in condition page #7
- Chart does not appear when opened from search - #225
----
<1> Sane and descriptive commit first line, in Github, this is the title of the pull request
<2> Optional, short description of this commit
<3> List of issues addressed in this pull request

TIP: Try to keep your pull requests short and sweet

==== Receive feedback
Expand Down
2 changes: 1 addition & 1 deletion book/standards/javascript/00index.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Introduction
~~~~~~~~~~~~

* Focus on readability and maintainability. The code's should be easy to
understand, or obvious, to a junior-level developer.
understand, include some documentation, or obvious, to a junior-level developer.
* Write tests. Every project should have a functional test runner, and
be - configured to run the tests via CI.
* Use bower for your frontend components. Check in the artifacts to
Expand Down