Skip to content

Latest commit

 

History

History
75 lines (52 loc) · 2.89 KB

CONTRIBUTING.md

File metadata and controls

75 lines (52 loc) · 2.89 KB
Raw

Contributing

🙏 First off, thank your very much for considering contributing to Hajime. It's people like you that make Hajime such a great software. ❤️

Where do I go from here?

If you have noticed a 🐛 or have a feature request, submit an issue as you please! It's generally best if you get confirmation of your bug or approval for your feature request this way before starting to code.

If you have a general question about Hajime, you can send me an email.

Also be sure to take note of our code of conduct.

Fork & create a branch

If this something you can contribute, then fork Hajime and create a branch with a descriptive name.

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

git chekout -b 123-add-japanese-translations

At this point you add code!

Make a Pull Request (PR)

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

git remote add upstream git@github.com:Maus3rSR/Hajime.git
# or with https git remote add upstream https://github.com/Maus3rSR/Hajime.git
git checkout master
git pull upstream master

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

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

Finally, go to GitHub and make a Pull Request ✨

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 123-add-japanese-translations
git pull --rebase upstream master
git push --force-with-lease 123-add-japanese-translations

What we currently need most

⚠️ Main author note: The project is very young and still need a lot of preparation, development and documentation improvements which will allow the project to be pleasant for any developer wanting to contribute to it. I am sorry if it is not.

  • Get the MVP done (see the roadmap in README.md)
  • Changelog maintenance
  • Semver convention
  • Contribution informations for maintainers about Merging a PR and Shipping a version
  • Conventions & code quality check
  • Unit testing and code coverage
  • CI/CD