diff --git a/guide_for_contributing.txt b/guide_for_contributing.md similarity index 94% rename from guide_for_contributing.txt rename to guide_for_contributing.md index 47689418..ee07d078 100644 --- a/guide_for_contributing.txt +++ b/guide_for_contributing.md @@ -1,4 +1,4 @@ -Guide for contributing to this repository +# Guide for contributing to this repository I like my code to be tidy, so it saves me time if yours is too. Here are a few general guidelines for how to submit a good PR: @@ -10,4 +10,4 @@ I like my code to be tidy, so it saves me time if yours is too. Here are a few g - Follow naming conventions. BLOCK_CAPITALS for constants, CapitalisedWords for classes, camelCase for almost everything else. -- This isn't code related, but when you submit a PR, please tell me what it does! You don't need much, just something like "Makes item X do X" or "Fixes #162". If you're resolving an issue, put "Fixes", "Closes" or "Resolves" and then the issue number and Github will close it automatically. \ No newline at end of file +- This isn't code related, but when you submit a PR, please tell me what it does! You don't need much, just something like "Makes item X do X" or "Fixes #162". If you're resolving an issue, put "Fixes", "Closes" or "Resolves" and then the issue number and Github will close it automatically.