This project is work of many contributors. You're encouraged to submit pull requests, propose features and discuss issues.
In the examples below, substitute your Github username for contributor
in URLs.
Fork the project on Github and check out your copy.
git docs https://github.com/contributor/CoCreate-docs.git
cd CoCreate-docs
git remote add upstream https://github.com/CoCreate-app/CoCreate-docs.git
Make sure your fork is up-to-date and create a topic branch for your feature or bug fix on dev branch.
git checkout dev
git pull upstream dev
git checkout -b my-feature-branch
Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build.
We definitely appreciate pull requests that highlight or reproduce a problem, even without a fix.
Implement your feature or bug fix.
Document any external behavior in the README.
Make sure git knows your name and email address:
git config --global user.name "Your Name"
git config --global user.email "contributor@example.com"
We use semantic-release as process to generate changelog and to release. Write meaningful commits according to Commit Message Formats is important.
git add ...
git commit -am "commit-type(optional topic): a meaningful message"
Here is an example of the release type that should be done based on a semantic-release:
Commit message | Release type |
---|---|
fix(pencil): stop graphite breaking when too much pressure applied |
Patch Release |
feat(pencil): add 'graphiteWidth' option |
|
perf(pencil): remove graphiteWidth option BREAKING CHANGE: The graphiteWidth option has been removed. The default graphite width of 10mm is always used for performance reasons. |
git push origin my-feature-branch
Go to https://github.com/CoCreate-app/CoCreate-docs and select your feature branch. Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.
If you've been working on a change for a while, rebase with upstream/dev.
git fetch upstream
git rebase upstream/dev
git push origin my-feature-branch -f
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 in there!
Please do know that we really appreciate and value your time and work. We love you, really.