Skip to content

Latest commit

 

History

History
104 lines (73 loc) · 3.87 KB

CONTRIBUTING.md

File metadata and controls

104 lines (73 loc) · 3.87 KB
Raw

Contributing

First off, thank you for considering contributing to the library invoice-generator!

1. Where do I go from here?

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

2. 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 happening.

3. I can fix this!

At this point, you're ready to make your changes! Feel free to ask for help!

If this is something you think you can fix, then fork invoice-generator 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 develop
git checkout -b 325-add-mynewchanges

4. Code of Conduct

By being part of our development team and community, please abide the rules in our Code of Conduct! Further information on how to report inapropriate behaviour by others, check the Enforcements-Section in said Code Of Conduct. Thank you for being a nice person!

5. Code Styles, Guildlines & Inspections

Since we're trying to keep the code structured, readable and standardised, please check out and implement our Code Styles & Inspections if you are using IntelliJ IDEA.

Code Styles (Add Scheme under Project Settings > Editor > Code Style)

Inspections (Add Profile under Project Settings > Editor > Inspections)

6. Make a pull request

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

git remote add upstream [email protected]/dvbern/invoice-generator.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-mynewchanges
git rebase master
git push --set-upstream origin 325-add-mynewchanges

Finally, go to GitHub and make a Pull Request

7. Keeping your pull request updated

If a maintainer asks you to "rebase" your pull request, 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-mynewchanges
git pull --rebase upstream develop
git push --force-with-lease 325-add-mynewchanges

8. Merging a pull request (maintainers only)

A pull request can only be merged into develop by a maintainer if:

  • It is passing the tests.
  • It has been approved by at least two maintainers. If it was a maintainer who opened the pull request, only one extra approval is needed.
  • It has no requested changes.
  • It is up to date with current develop.

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