Contributing Guidelines¶
You are more than welcome to contribute to RawRabbit
. Here are some guidelines for the process.
Create issue¶
With a few exceptions, every commits should be connected to an issue. That means that if you’ve found a bug or implemented a feature, it should be reported in the issue section.
Write code¶
Write as beautiful code as possible! RawRabbit
is indented with tabs and not spaces.
Commit Code¶
Make sure that all commits start with (#issue-number)
, like (#19) Invoke message handlers in sync manner
. This way, the commits will appear in the issue and is easier found from the console git log --grep #19
.
Follow the official guide lines. In short, the seven rules of a great git commit message should be honored:
- Separate subject from body with a blank line
- Limit the subject line to 50 characters
- Capitalize the subject line
- Do not end the subject line with a period
- Use the imperative mood in the subject line
- Wrap the body at 72 characters
- Use the body to explain what and why vs. how
Create Pull Request¶
Once the feature is developed, create a pull to stable
.