botlabs-gg / yagpdb-docs-v2

YAGPDB's (new) documentation and custom commands course.
http://help.yagpdb.xyz/
Creative Commons Attribution Share Alike 4.0 International
6 stars 10 forks source link

meta: contrib guide and pr template #11

Closed l-zeuch closed 9 months ago

l-zeuch commented 9 months ago

This is a combination of two commits:

Add contributing guidelines, outlining where to go for general support and bug reports, as well as how to submit a pull request.

We define a specification for commit messages, such that it is easier to read and parse the git shortlog and thus generate proper changelogs. This specification is intended to present a basic "skill-check" to avoid rushed contributions with no real value, but they are by no means meant to be difficult to work with.

To make sure as many potential contributors as possible find these guidelines, do link to it from the README, although GitHub should already prompt contributors to read them, given it is located in any of the documented locations where GitHub detects this special file.

Add a basic pull request template, linking once more to the contributing guidelines. Mention said template in our contributing guide.

The template is deliberately simple and lean. Assuming properly formatted commit messages, GitHub should automatically fill in the template with said message, minus some potential reordering thereof.

Signed-off-by: Luca Zeuch l-zeuch@email.de