From 5cae401c98f40765f5e9baad05d916976718b4b9 Mon Sep 17 00:00:00 2001 From: Jen Hamon Date: Wed, 1 Apr 2015 13:06:58 -0700 Subject: [PATCH 1/2] Pull urls out of paragraph to improve readability --- CONTRIBUTING.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5b46580a8..7b023f758 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,12 @@ # Developing for Jasmine Core -We welcome your contributions - Thanks for helping make Jasmine a better project for everyone. Please review the backlog and discussion lists (the main group - [http://groups.google.com/group/jasmine-js](http://groups.google.com/group/jasmine-js) and the developer's list - [http://groups.google.com/group/jasmine-js-dev](http://groups.google.com/group/jasmine-js-dev)) before starting work - what you're looking for may already have been done. If it hasn't, the community can help make your contribution better. +We welcome your contributions! Thanks for helping make Jasmine a better project for everyone. Please review the backlog and discussion lists before starting work. What you're looking for may already have been done. If it hasn't, the community can help make your contribution better. + +## Links + +- [Jasmine Google Group](http://groups.google.com/group/jasmine-js) +- [Jasmine-dev Google Group](http://groups.google.com/group/jasmine-js-dev) +- [Jasmine on PivotalTracker](https://www.pivotaltracker.com/n/projects/10606) ## General Workflow From 76bc0a87db7d359d69805881062b6b79f716a618 Mon Sep 17 00:00:00 2001 From: Jen Hamon Date: Wed, 1 Apr 2015 13:25:32 -0700 Subject: [PATCH 2/2] Use code fence syntax around git workflow for readability. --- CONTRIBUTING.md | 23 +++++++++++------------ 1 file changed, 11 insertions(+), 12 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7b023f758..5df3b4e23 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,18 +12,17 @@ We welcome your contributions! Thanks for helping make Jasmine a better project Please submit pull requests via feature branches using the semi-standard workflow of: -1. Fork it -1. Clone your fork: (`git clone git@github.com:yourUserName/jasmine.git`) -1. Change directory: (`cd jasmine`) -1. Assign original repository to a remote named 'upstream': (`git remote add -upstream https://github.com/jasmine/jasmine.git`) -1. Pull in changes not present in your local repository: (`git fetch upstream`) -1. Create your feature branch (`git checkout -b my-new-feature`) -1. Commit your changes (`git commit -am 'Add some feature'`) -1. Push to the branch (`git push origin my-new-feature`) -1. Create new Pull Request - -We favor pull requests with very small, single commits with a single purpose. +```bash +git clone git@github.com:yourUserName/jasmine.git # Clone your fork +cd jasmine # Change directory +git remote add upstream https://github.com/jasmine/jasmine.git # Assign original repository to a remote named 'upstream' +git fetch upstream # Pull in changes not present in your local repository +git checkout -b my-new-feature # Create your feature branch +git commit -am 'Add some feature' # Commit your changes +git push origin my-new-feature # Push to the branch +``` + +Once you've pushed a feature branch to your forked repo, you're ready to open a pull request. We favor pull requests with very small, single commits with a single purpose. ## Background