Contribution guidelines - Githubissues

alfredopalhares / yats-old

Yet Another Tunning Software

0 stars 0 forks source link

Contribution guidelines #5

Closed alfredopalhares closed 9 years ago

alfredopalhares commented 10 years ago

Document contribution guidelines ond a CONTRIBUTING.md file

Commiting Guidelines

[x] The usage of verbs in the infinitive, like Add, Update. Remove or Fix``.
[x] The tile should describe the what and the body should describe the why of the commit.
[x] Describe the name of branches.

Good blog post with some information.

Coding Style

[x] Brackets usage.
[x] Identation.
[ ] How to describe tests.

Take some ideas from the linux kernel documentation

Realeasing

[x] Document the usage of semver.
[x] How to write useful release notes.

Submiting Issues

[x] Writing Guidelines
[x] Document how to provide as most information as possible about the environmnet when submiting a bug.
[x] The usage of labels
[x] Priority

alfredopalhares commented 9 years ago

There are no tests at the moment, it will be documented when they start to be implemented.