From 77b5a79a49f06c217dbed25ce9d5d837b5fac72d Mon Sep 17 00:00:00 2001 From: Mcat12 Date: Fri, 5 Feb 2016 12:21:16 -0500 Subject: [PATCH] Moved contributor info --- CONTRIBUTING.md | 9 +++++++++ README.md | 12 ------------ 2 files changed, 9 insertions(+), 12 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..64e702f8 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,9 @@ +This is a basic checklist for now, We will update it in the future. + +* Fork the repo and create your new branch based on the `devel` (development) branch. +* Use 4 spaces instead of tabs +* Commit Unix line endings +* If you want, try to keep to the theme of black holes/gravity. This can add some fun to your submission. +* Submit Pull Requests to the development branch only. +* Before Submitting your Pull Request, merge `devel` with your new branch and fix any conflicts. (Make sure you don't break anything in development!) +* Be patient. We will review all submitted pull requests, but our focus is on stability.. please don't be offended if we reject your PR, or it appears we're doing nothing with it! We'll get around to it.. diff --git a/README.md b/README.md index ecd91c84..7f782af9 100644 --- a/README.md +++ b/README.md @@ -19,15 +19,3 @@ A basic read-only API can be accessed at `/admin/api.php`. It returns the follow "ads_percentage_today": 80.892423238348 } ``` - -## Contributing -If you would like to add to the project, please make sure to follow these guidelines: - -1. Branch off of ```devel``` into your own feature branch (ex. ```feature```). -2. When you are finished, make a pull request to merge your ```feature``` branch into ```devel```. - -Keep these things in mind: - -* Use 4 spaces instead of tabs -* Commit Unix line endings -* If you want, try to keep to the theme of black holes/gravity. This can add some fun to your submission.