Skip to content
This repository has been archived by the owner on Nov 7, 2020. It is now read-only.

Latest commit

聽

History

History
76 lines (54 loc) 路 2.61 KB

CONTRIBUTING.md

File metadata and controls

76 lines (54 loc) 路 2.61 KB
Raw

Contributing

First off, thank you for considering contributing to EVE Book. It's people like you that make EVE Book possible.

1. Where do I go from here?

If you've noticed a bug or have a question, you should check if someone else in the community has already created a ticket by searching the issue tracker. If not, go ahead and make one or ask directly on slack in #evebook. For bigger questions is better to use issue tracking.

2. Fork & create a branch

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

A good branch name would be (where issue #325 is the ticket you're working on):

git checkout -b 325-add-japanese-translations

3. Did you find a bug?

  • Ensure the bug was not already reported by searching all 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.

4. 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 馃樃

5. Watch out for tests and code style

We are using tslint and AirBNB code style to make sure code style stays the same.

Tests are another things that helps us work faster and produce less bugs in code. After you fixed bug or implemented feauture, make sure it passes all the tests. If you introduced new functionality, you should write tests for it.

5. Make a Pull Request

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

git remote add upstream git@github.com:evebook/api.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. We care about quality, so your PR won't be merged until all tests pass.