Skip to content

Latest commit

 

History

History
71 lines (52 loc) · 2.65 KB

CONTRIBUTING.md

File metadata and controls

71 lines (52 loc) · 2.65 KB
Raw

Hey there,

Thanks for your interest in contributing to Aeons End Randomizer. Below you find a few guidelines on how to contribute best to the project:

ToC

Feature Requests

If you have new ideas for the app or specific feature requests, make sure to have a look at existing issues first. If you don't see anything resembling your idea feel free to open a new issue by using the provided feature template. We will then join the discussion and have a look at it, as soon as possible.

Bugs

If you experienced anything unusual, the app crashed or a Nemesis crashed your birthday party (because of our app... otherwise... we are still interested - sounds like a hell of a story), feel free to open a bug issue by using the provided bug template. We will then check the severity of the bug and act accordingly ;)

Working on issues directly

Please talk to us before you start coding - there are issues we might want to tackle ourselves or issues which lack a proper detailed description of what we actually would like to achieve. Therefore drop us a few lines inside the respective issue and we will get in touch with you.

Pull Requests

Before you send a pull request into review, check the following steps:

  • Does the PR target the correct branch?:
    • Does the corresponding issue have a milestone? -> target the respective release branch
    • Is it a severe bug? -> target main (we will change the branch if necessary)
  • Squash your commits locally - usually your PR should contain exactly one commit (of course there are exceptions to this rule)
  • Follow these commit rules:
    • First line no longer than 50 characters
    • Start with commit type:
      • FEATURE if it contains new functionality
      • BUGFIX if it contains a fix
      • TASK if it contains some "under the hood" doings (e.g. CI changes etc.)
    • Follow with the commit messag in presence (e.g. "Fix but that caused...")
    • Leave the second line empty
    • Tag the github issue on the the third line (e.g. "Issue: #1")
    • leave the fourth line empty
    • From line 5 on: Add a detailed description of the things you did, if you feel that it would be helpful
  • Assign a reviewer

We will then try to review your PR as quickly as possible.

Example commit message

[FEATURE] Added cookies to the cookie bowl

Issue: #1

The cookie bowl was empty, which is quite unfortunate if you are awaiting guests.
Therefore I gave it a nice re-fill.