Skip to content
This repository has been archived by the owner on Dec 22, 2021. It is now read-only.

Latest commit

 

History

History
120 lines (81 loc) · 4.24 KB

CONTRIBUTING.md

File metadata and controls

120 lines (81 loc) · 4.24 KB

Since this project is now deprecated, we will not be accepting any new pull requests.

Contributing

First off, thanks for considering contributing to this project! It's people like you that make this project a great tool.

Where do I go from here?

If you've noticed a bug or have a feature request, make an issue! 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 this project 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-condense-storage-entries

Get the suite running

Make sure you're using a current version of node.js (v16 LTS or v17) with a current version of npm:

Now install the dependencies:

npm install

To update the built extension run:

npm run build

The build script will make a extension ready for loading in unpacked mode to a Chromium browser.

There is also a script to update navdata, dependencies, build the extension. Here's the command to run the suite:

npm run suite

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 😸

Make sure you update the version number in manifest.json. Here's how to do that:

  • The last digit (e.g. 3.2.3) is for patches. If you're fixing a bug, increment this number. (e.g. 3.2.4)
  • The second digit (e.g. 3.2.3) is for new features. If you're adding a new option, or adding a new functionality to a script, increment this digit and reset the digits right of it to 0. (3.3.0)
  • The first digit (e.g. 3.2.3) is for very major releases. If your change doesn't fall into the other catagories, increment this digit and reset the digits right of it to 0. You should also open a discussion for this. (e.g. 4.0.0)

Make a Pull Request

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

git remote add upstream [email protected]:geofs-extensions/autoland.git
git checkout main
git pull upstream main

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

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

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

GitHub Actions will run a test suite against your PR. We care about quality, so your PR won't be merged until all tests pass. We'll also manually test the extension before approving your PR.

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.

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 main
git push --force-with-lease 325-add-japanese-translations

Merging a PR (maintainers only)

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

  • It is passing CI.
  • It has been approved by at least two maintainers. If it was a maintainer who opened the PR, only one other approval is needed.
  • It has no requested changes.
  • It is up to date with current main.

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

Thanks to the Active Admin Contributing guide for inspiring this Contributing guide!