Permalink
Browse files

Add a CONTRIBUTING.md with a few guidelines

This will be picked up by GitHub and will be shown in the tracker when a new
ticket is about to be opened.

See:
  https://github.com/blog/1184-contributing-guidelines
  • Loading branch information...
1 parent 30b8214 commit 1aeeb1c8ddc7e94002fed397658ef3a7e3d5c466 @etdsoft etdsoft committed Sep 17, 2012
Showing with 73 additions and 12 deletions.
  1. +72 −0 CONTRIBUTING.md
  2. +1 −12 README.md
View
@@ -0,0 +1,72 @@
+# How to contribute
+
+Third-party patches are essential for keeping dradis great. We simply can't
+access the huge number of platforms and myriad configurations for running
+dradis. We want to keep it as easy as possible to contribute changes that
+get things working in your environment. There are a few guidelines that we
+need contributors to follow so that we can have a chance of keeping on
+top of things.
+
+
+## Getting Started
+
+* Make sure you have a [GitHub account](https://github.com/signup/free)
+* Submit a ticket for your issue, assuming one does not already exist.
+ * Clearly describe the issue including steps to reproduce when it is a bug.
+ * Make sure you fill in the earliest version that you know has the issue.
+* Fork the repository on GitHub
+
+
+## Making Changes
+
+* Create a topic branch from where you want to base your work.
+ * This is usually the master branch.
+ * Only target release branches if you are certain your fix must be on that
+ branch.
+ * To quickly create a topic branch based on master; `git branch
+ fix/master/my_contribution master` then checkout the new branch with `git
+ checkout fix/master/my_contribution`. Please avoid working directly on the
+ `master` branch.
+* Make commits of logical units.
+* Check for unnecessary whitespace with `git diff --check` before committing.
+* Make sure your commit messages are in the proper format.
+
+````
+ (#99999) Make the example in CONTRIBUTING imperative and concrete
+
+ Without this patch applied the example commit message in the CONTRIBUTING
+ document is not a concrete example. This is a problem because the
+ contributor is left to imagine what the commit message should look like
+ based on a description rather than an example. This patch fixes the
+ problem by making the example concrete and imperative.
+
+ The first line is a real life imperative statement with a ticket number
+ from our issue tracker. The body describes the behavior without the patch,
+ why this is a problem, and how the patch fixes the problem when applied.
+
+ If you need to add external references, here is how to do so.
+
+ See:
+ http://securityreactions.tumblr.com/post/31726556638/we-have-an-ids-and-a-waf
+````
+
+* Make sure you have added the necessary tests for your changes.
+* Run _all_ the tests to assure nothing else was accidentally broken.
+
+## Submitting Changes
+
+* Review our [Contributor's Agreement](https://github.com/dradis/dradisframework/wiki/Contributor%27s-agreement). Sending us a pull request means you have read and accept to this agreement
+* Push your changes to a topic branch in your fork of the repository.
+* Submit a **pull request** to the repository in the dradis organization.
+* Include a link to the pull request in the ticket
+
+
+# Additional Resources
+
+* [Contributor License Agreement](https://github.com/dradis/dradisframework/wiki/Contributor%27s-agreement)
+* [General GitHub documentation](http://help.github.com/)
+* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)
+* **#dradis** IRC channel on freenode.org
+* [dradis-devel](https://lists.sourceforge.net/mailman/listinfo/dradis-devel) development mailing list
+* Dradis Guides: http://guides.dradisframework.org
+* [Community Forums](http://dradisframework.org/community/)
View
@@ -112,18 +112,7 @@ Getting help
Contributing
------------
-* Join the developer discussion at: [dradis-devel](https://lists.sourceforge.net/mailman/listinfo/dradis-devel)
-* [Report a bug](https://github.com/dradis/dradisframework/issues)
-* Help with the [Dradis Guides](https://github.com/dradis/dradisguides) project or submit your guide.
-* Submit a patch:
- * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
- * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
- * Fork the project
- * Start a feature/bugfix branch
- * Commit and push until you are happy with your contribution
- * Make sure to add tests for it. This is important so we don't break it in a future version unintentionally.
- * Review our [Contributor's Agreement](https://github.com/dradis/dradisframework/wiki/Contributor%27s-agreement). Sending us a pull request means you have read and accept to this agreement
- * Send us a [pull request](http://help.github.com/pull-requests/)
+Please see CONTRIBUTING.md for details.
License

0 comments on commit 1aeeb1c

Please sign in to comment.