|
| 1 | +## Contributing |
| 2 | + |
| 3 | +First off, thank you for considering contributing to this repo. It's people |
| 4 | +like you that make this material such a great tutorial. |
| 5 | + |
| 6 | +### 1. Found a bug, have a question or want to add a new feature |
| 7 | + |
| 8 | +If you've noticed a bug, a feature or have a question go ahead and [open an issue](https://github.com/leandromoreira/digital_video_introduction/issues/new)! |
| 9 | + |
| 10 | +### 2. Fork & create a branch |
| 11 | + |
| 12 | +> * **Ensure the bug was not already reported** by [searching all issues](https://github.com/leandromoreira/digital_video_introduction/issues?q=). |
| 13 | +
|
| 14 | +If this is something you think you can fix, then |
| 15 | +[fork digital_video_introduction](https://help.github.com/articles/fork-a-repo) |
| 16 | +and create a branch with a descriptive name. |
| 17 | + |
| 18 | +A good branch name would be (where issue #325 is the ticket you're working on): |
| 19 | + |
| 20 | +```sh |
| 21 | +git checkout -b 325-add-japanese-translations |
| 22 | +``` |
| 23 | + |
| 24 | +### 3. Implement your fix or feature |
| 25 | + |
| 26 | +At this point, you're ready to make your changes! |
| 27 | + |
| 28 | +### 4. Make a Pull Request |
| 29 | + |
| 30 | +At this point, you should switch back to your master branch and make sure it's |
| 31 | +up to date with Active Admin's master branch: |
| 32 | + |
| 33 | +```sh |
| 34 | +git remote add upstream [email protected]:leandromoreira/digital_video_introduction.git |
| 35 | +git checkout master |
| 36 | +git pull upstream master |
| 37 | +``` |
| 38 | + |
| 39 | +Then update your feature branch from your local copy of master, and push it! |
| 40 | + |
| 41 | +```sh |
| 42 | +git checkout 325-add-japanese-translations |
| 43 | +git rebase master |
| 44 | +git push --set-upstream origin 325-add-japanese-translations |
| 45 | +``` |
| 46 | + |
| 47 | +Finally, go to GitHub and |
| 48 | +[make a Pull Request](https://help.github.com/articles/creating-a-pull-request) |
| 49 | +:D |
| 50 | + |
| 51 | +### 5. Merging a PR (maintainers only) |
| 52 | + |
| 53 | +A PR can only be merged into master by a maintainer if: |
| 54 | + |
| 55 | +* It was reviewed. |
| 56 | +* It is up to date with current master. |
| 57 | + |
| 58 | +Any maintainer is allowed to merge a PR if all of these conditions are |
| 59 | +met. |
| 60 | + |
| 61 | +PS: this contributing text was inspired by active admin contributing. |
0 commit comments