Skip to content

Latest commit

 

History

History
51 lines (33 loc) · 1.71 KB

CONTRIBUTING.md

File metadata and controls

51 lines (33 loc) · 1.71 KB

Contributing

First off, thank you for considering contributing to AyBorg. We want to keep it as easy as possible to contribute changes that get things working in your environment.

Where do I go from here?

If you've noticed a bug or have a feature request, make one! It's generally best if you get confirmation of your bug or approval for your feature request this way before starting to code.

Fork & create a branch

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

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

git checkout -b 777-fix-ean-encoding

Get the style right

We provding a .editorconfig file to help you with the style of the project. Most editors support EditorConfig, but you may need to install a plugin.

Make a Pull Request

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

git remote add upstream [email protected]:Source-Alchemists/AyBorg.git
git checkout main
git pull upstream main

Then update your feature branch from your local main branch, and push it!

git checkout 777-fix-ean-encoding
git rebase main
git push --set-upstream origin 777-fix-ean-encoding

Finally, go to the AyBorg repo and make a Pull Request.

Keep your Pull Request updated

If we ask you to rebase your Pull Request, you can do it by:

git checkout 777-fix-ean-encoding
git pull --rebase upstream main
git push --force-with-lease 777-fix-ean-encoding