Skip to content

Latest commit

 

History

History
32 lines (25 loc) · 1.95 KB

CONTRIBUTING.md

File metadata and controls

32 lines (25 loc) · 1.95 KB

Hey contributor!

Yes, YOU. Read this document to get an idea of how to contribute to rNum (and hopefully, maybe, eventually other rSeries projects?).

About

Every little thing helps. Making code changes is great, but it is not the only way to help out! If you are looking for something to work on, then look at the Issues page or contact a maintainer.

Communication

For the best chance of your pull request being merged, it is highly recommended that you open a GitHub issue regarding your feature/contribution or contact one of the maintainers of the project (Currently @Vio-Eli or @snowfoxsh).

Humor and charm are welcome here; however, there's a fine line between a playful joke and harmful comments. Respect and kindness are paramount. You've graduated from kindergarten; you know the drill.

Commit messages

Please prefix your commit with a [TAG]. Your "tag" is unique to you! Aren't you so special? It is a three-character identifier that clarifies who is responsible for a change.

Why do this in the age of git blame?

  • It makes it easier to see who did what from the terminal, at a glance.

Examples

Message Description
[uni] do the things Single person commit message
[uni]- do bad things Add a temporary change that does not compile
[uni]~ do partial things Add a temporary change that the contributor considers incomplete
[uni][vio] do complex things Add a change that was authored by multiple people
[uni]>_ cargo fmt You might see this occasionally represent running one command
[uni]+ cargo fmt You might see this occasionally represent running one command

[!WARNING] Dont impersonate people