|
| 1 | +# Contributing to CoCreate-file |
| 2 | + |
| 3 | +This project is work of [many contributors](https://github.com/CoCreate-app/CoCreate-file/graphs/contributors). |
| 4 | +You're encouraged to submit [pull requests](https://github.com/CoCreate-app/CoCreate-file/pulls), |
| 5 | +[propose features and discuss issues](https://github.com/CoCreate-app/CoCreate-file/issues). |
| 6 | + |
| 7 | +In the examples below, substitute your Github username for `contributor` in URLs. |
| 8 | + |
| 9 | +## Fork the Project |
| 10 | + |
| 11 | +Fork the [project on Github](https://github.com/CoCreate-app/CoCreate-file) and check out your copy. |
| 12 | + |
| 13 | +``` |
| 14 | +git clone https://github.com/contributor/CoCreate-file.git |
| 15 | +cd CoCreate-file |
| 16 | +git remote add upstream https://github.com/CoCreate-app/CoCreate-file.git |
| 17 | +``` |
| 18 | + |
| 19 | +## Create a Topic Branch |
| 20 | + |
| 21 | +Make sure your fork is up-to-date and create a topic branch for your feature or bug fix. |
| 22 | + |
| 23 | +``` |
| 24 | +git checkout master |
| 25 | +git pull upstream master |
| 26 | +git checkout -b my-feature-branch |
| 27 | +``` |
| 28 | + |
| 29 | +## Write Tests |
| 30 | + |
| 31 | +Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build. |
| 32 | +Add to [spec](spec). |
| 33 | + |
| 34 | +We definitely appreciate pull requests that highlight or reproduce a problem, even without a fix. |
| 35 | + |
| 36 | +## Write Code |
| 37 | + |
| 38 | +Implement your feature or bug fix. |
| 39 | + |
| 40 | +## Write Documentation |
| 41 | + |
| 42 | +Document any external behavior in the [README](README.md). |
| 43 | + |
| 44 | +## Update Changelog |
| 45 | + |
| 46 | +Add a line to [CHANGELOG](CHANGELOG.md) under _Next Release_. |
| 47 | +Make it look like every other line, including your name and link to your Github account. |
| 48 | + |
| 49 | +## Commit Changes |
| 50 | + |
| 51 | +Make sure git knows your name and email address: |
| 52 | + |
| 53 | +``` |
| 54 | +git config --global user.name "Your Name" |
| 55 | +git config --global user.email "[email protected]" |
| 56 | +``` |
| 57 | + |
| 58 | +Writing good commit logs is important. A commit log should describe what changed and why. |
| 59 | + |
| 60 | +``` |
| 61 | +git add ... |
| 62 | +git commit |
| 63 | +``` |
| 64 | + |
| 65 | +## Push |
| 66 | + |
| 67 | +``` |
| 68 | +git push origin my-feature-branch |
| 69 | +``` |
| 70 | + |
| 71 | +## Make a Pull Request |
| 72 | + |
| 73 | +Go to [https://github.com/CoCreate-app/CoCreate-file](https://github.com/CoCreate-app/CoCreate-file) and select your feature branch. |
| 74 | +Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days. |
| 75 | + |
| 76 | +## Rebase |
| 77 | + |
| 78 | +If you've been working on a change for a while, rebase with upstream/master. |
| 79 | + |
| 80 | +``` |
| 81 | +git fetch upstream |
| 82 | +git rebase upstream/master |
| 83 | +git push origin my-feature-branch -f |
| 84 | +``` |
| 85 | + |
| 86 | +## Update CHANGELOG Again |
| 87 | + |
| 88 | +Update the [CHANGELOG](CHANGELOG.md) with the pull request number. A typical entry looks as follows. |
| 89 | + |
| 90 | +``` |
| 91 | +* [#123](https://github.com/CoCreate-app/CoCreate-industry/pull/123): Reticulated splines - [@contributor](https://github.com/contributor). |
| 92 | +``` |
| 93 | + |
| 94 | +Amend your previous commit and force push the changes. |
| 95 | + |
| 96 | +``` |
| 97 | +git commit --amend |
| 98 | +git push origin my-feature-branch -f |
| 99 | +``` |
| 100 | + |
| 101 | +## Check on Your Pull Request |
| 102 | + |
| 103 | +Go back to your pull request after a few minutes and see whether it passed muster with Travis-CI. Everything should look green, otherwise fix issues and amend your commit as described above. |
| 104 | + |
| 105 | +## Be Patient |
| 106 | + |
| 107 | +It's likely that your change will not be merged and that the nitpicky maintainers will ask you to do more, or fix seemingly benign problems. Hang on there! |
| 108 | + |
| 109 | +## Thank You |
| 110 | + |
| 111 | +Please do know that we really appreciate and value your time and work. We love you, really. |
0 commit comments