From 7481bdc1bb11ed85e74ac468acb1a903926172b6 Mon Sep 17 00:00:00 2001 From: Adrian L Lange Date: Sun, 11 Jan 2015 21:41:46 +0100 Subject: [PATCH] Add a CONTRIBUTING file --- .pkgmeta | 3 +++ CONTRIBUTING.md | 32 ++++++++++++++++++++++++++++++++ 2 files changed, 35 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/.pkgmeta b/.pkgmeta index d21a61f..f7c6d78 100644 --- a/.pkgmeta +++ b/.pkgmeta @@ -3,3 +3,6 @@ package-as: oUF_Reputation manual-changelog: filename: CHANGELOG.md markup-type: markdown + +ignore: + - CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..1cee3f5 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,32 @@ +## Issues + +If you have an issue with the addon and you'd like to report it, please follow these steps: + +- Make sure you've got a GitHub account, you can sign up [here](https://github.com/join). +- Make sure it's this addon causing the issue by running it alone to verify. + - If there is a compatibility issue, please report that too. +- Please describe the issue as best you can, and include as many details as you can. +- Some details are required: + - What version are you using? (don't say "latest" or "newest"). + - Can you reproduce it, and if you can, how? + - If there was an error message, include it. + - If it is a graphical issue, include a screenshot (use [imgur](https://imgur.com/) or something). +- Make sure you check back often until the issue is resolved for any follow-up questions. + +You can report issues by clicking the "Issues" button on the right of by following [this link](https://github.com/p3lim-wow/oUF_Reputation/issues). + +## Contributing + +If you would like to contribute with a feature, bug fix or any other sort of improvement, please follow the steps below. +Since I am using git for this project, it is required that you know how to use it to contribute. + +- Make sure you've got a GitHub account, you can sign up [here](https://github.com/join). +- [Fork](https://github.com/p3lim-wow/oUF_Reputation/fork) the project, this gives you a copy of the addon's source files on your account. +- Clone your copy of the project and make a new branch. +- Make your changes, and make sure you test them **thoroughly!** +- Before you commit your changes, make sure to follow some simple code style guidelines: + - Use tabs, not spaces. + - Don't leave andy trailing whitespace. +- Commit your changes with a short but descriptive description of what the changes do, then push to GitHub. +- File a [pull request](https://github.com/p3lim-wow/oUF_Reputation/compare). +- Make sure you check back often until the changes are merged for any follow-up questions. -- 1.7.9.5