Skip to content

Latest commit

 

History

History
98 lines (68 loc) · 3.22 KB

CONTRIBUTING.md

File metadata and controls

98 lines (68 loc) · 3.22 KB
Raw

Contributing

First off, thank you for considering contributing to gocnab. It's people like you that make gocnab such a great library.

1. Where do I go from here?

If you've noticed a bug or have a question that doesn't belong on the Stack Overflow, search the issue tracker to see if someone else in the community has already created a ticket. If not, go ahead and make one!

2. Fork & create a branch

If this is something you think you can fix, then fork gocnab and create a branch with a descriptive name.

3. Get the test suite running

Make sure you're using a recent Go compiler and run the entire suite using:

go test

4. Did you find a bug?

  • Ensure the bug was not already reported by searching on GitHub under Issues.

  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

5. Implement your fix or feature

At this point, you're ready to make your changes! Feel free to ask for help; everyone is a beginner at first 😸

6. View your changes running the tool

Unit test cases can sometimes not cover all corners. So make sure to take a look at your changes running it for real.

7. Make a Pull Request

At this point, you should switch back to your master branch and make sure it's up to date with gocnab's master branch:

git remote add upstream git@github.com:rafaeljusto/gocnab.git
git checkout master
git pull upstream master

Then update your feature branch from your local copy of master, and push it!

git checkout 325-add-japanese-translations
git rebase master
git push --set-upstream origin 325-add-japanese-translations

Finally, go to GitHub and make a Pull Request :D

Travis CI will run our test suite against all supported Go versions. We care about quality, so your PR won't be merged until all tests pass.

8. Keeping your Pull Request updated

If a maintainer asks you to "rebase" your PR, they're saying that a lot of code has changed, and that you need to update your branch so it's easier to merge.

To learn more about rebasing in Git, there are a lot of good resources, but here's the suggested workflow:

git checkout 325-add-japanese-translations
git pull --rebase upstream master
git push --force-with-lease 325-add-japanese-translations

9. Merging a PR (maintainers only)

A PR can only be merged into master by a maintainer if:

  • It is passing CI.
  • It has been approved by at least one maintainers.
  • It has no requested changes.
  • It is up to date with current master.

Any maintainer is allowed to merge a PR if all of these conditions are met.