CONTRIBUTING.md in hawatel_search_jobs-0.1.2 vs CONTRIBUTING.md in hawatel_search_jobs-0.1.3

- old
+ new

@@ -1,70 +1,70 @@ -# Contributing - -Bug reports and pull requests are welcome on GitHub at https://github.com/Hawatel/hawatel_search_jobs. This project is intended to be a safe, welcoming space for collaboration, and contributors. - -1. [Fork](https://help.github.com/articles/fork-a-repo/) the project, clone your fork, - and configure the remotes: - - ```sh - # Clone your fork of the repo into the current directory - git clone https://github.com/<your-username>/hawatel_search_jobs - # Navigate to the newly cloned directory - cd hawatel_search_jobs - # Assign the original repo to a remote called "upstream" - git remote add upstream https://github.com/Hawatel/hawatel_search_jobs - ``` - -2. If you cloned a while ago, get the latest changes from upstream: - - ```bash - git checkout master - git pull upstream master - ``` - -3. Create a new topic branch (off of `master`) to contain your feature, change, - or fix. - - **IMPORTANT**: Making changes in `master` is discouraged. You should always - keep your local `master` in sync with upstream `master` and make your - changes in topic branches. - - ```sh - git checkout -b <topic-branch-name> - ``` - -4. Commit your changes in logical chunks. Keep your commit messages organized, - with a short description in the first line and more detailed information on - the following lines. Feel free to use Git's - [interactive rebase](https://help.github.com/articles/about-git-rebase/) - feature to tidy up your commits before making them public. - -5. Make sure all the tests are still passing. - - ```sh - rake - ``` - -6. Push your topic branch up to your fork: - - ```sh - git push origin <topic-branch-name> - ``` - -7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/) - with a clear title and description. - -8. If you haven't updated your pull request for a while, you should consider - rebasing on master and resolving any conflicts. - - **IMPORTANT**: _Never ever_ merge upstream `master` into your branches. You - should always `git rebase` on `master` to bring your changes up to date when - necessary. - - ```sh - git checkout master - git pull upstream master - git checkout <your-topic-branch> - git rebase master - ``` - +# Contributing + +Bug reports and pull requests are welcome on GitHub at https://github.com/Hawatel/hawatel_search_jobs. This project is intended to be a safe, welcoming space for collaboration, and contributors. + +1. [Fork](https://help.github.com/articles/fork-a-repo/) the project, clone your fork, + and configure the remotes: + + ```sh + # Clone your fork of the repo into the current directory + git clone https://github.com/<your-username>/hawatel_search_jobs + # Navigate to the newly cloned directory + cd hawatel_search_jobs + # Assign the original repo to a remote called "upstream" + git remote add upstream https://github.com/Hawatel/hawatel_search_jobs + ``` + +2. If you cloned a while ago, get the latest changes from upstream: + + ```bash + git checkout master + git pull upstream master + ``` + +3. Create a new topic branch (off of `master`) to contain your feature, change, + or fix. + + **IMPORTANT**: Making changes in `master` is discouraged. You should always + keep your local `master` in sync with upstream `master` and make your + changes in topic branches. + + ```sh + git checkout -b <topic-branch-name> + ``` + +4. Commit your changes in logical chunks. Keep your commit messages organized, + with a short description in the first line and more detailed information on + the following lines. Feel free to use Git's + [interactive rebase](https://help.github.com/articles/about-git-rebase/) + feature to tidy up your commits before making them public. + +5. Make sure all the tests are still passing. + + ```sh + rake + ``` + +6. Push your topic branch up to your fork: + + ```sh + git push origin <topic-branch-name> + ``` + +7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/) + with a clear title and description. + +8. If you haven't updated your pull request for a while, you should consider + rebasing on master and resolving any conflicts. + + **IMPORTANT**: _Never ever_ merge upstream `master` into your branches. You + should always `git rebase` on `master` to bring your changes up to date when + necessary. + + ```sh + git checkout master + git pull upstream master + git checkout <your-topic-branch> + git rebase master + ``` + Thank you for your contributions! \ No newline at end of file