Permalink
Browse files

Updates README and adds CONTRIBUTING

  • Loading branch information...
1 parent dec753e commit beb1eb96df6a44f3a536d057cc57c9d863f1351e @el-mapache el-mapache committed May 20, 2016
Showing with 41 additions and 0 deletions.
  1. +38 −0 CONTRIBUTING.MD
  2. +3 −0 README.md
View
@@ -0,0 +1,38 @@
+# Welcome!
+
+We're so glad you're thinking about contributing to an 18F open source project! If you're unsure about anything, just ask — or submit your issue or pull request anyway. The worst that can happen is we'll politely ask you to change something. We appreciate all friendly contributions.
+
+One of our goals is to ensure a welcoming environment for all contibutors to our projects. Our staff follows the [18F Code of Conduct](https://github.com/18F/code-of-conduct/blob/master/code-of-conduct.md), and all contributors should do the same.
+
+We encourage you to read this project's CONTRIBUTING policy (you are here), and its [LICENSE](../LICENSE.md) and [README](../README.md).
+
+If you have any questions or want to read more, check out the [18F Open Source Policy GitHub repository]( https://github.com/18f/open-source-policy), or just [shoot us an email](mailto:18f@gsa.gov).
+
+## Guidelines
+
+
+### Submitting a pull request
+
+Here are a few guidelines to follow when submitting a pull request:
+
+1. Create a GitHub account or sign in to your existing account.
+1. Fork this repo into your GitHub account (or just clone it if you're an 18F team member). Read more about forking a repo here on GitHub:
+[https://help.github.com/articles/fork-a-repo/](https://help.github.com/articles/fork-a-repo/)
+1. Create a branch that lightly defines what you're working on (for example, add-styles).
+2. Write tests for your plugin, and ensure they pass.
+3. Submit your pull request against the `master` branch.
+
+Have questions or need help with setup? Open an issue here [https://github.com/18F/18F-stylelint](https://github.com/18F/18F-stylelint).
+
+
+### The rest of this project is in the public domain
+
+The rest of this project is in the worldwide [public domain](LICENSE.md).
+
+This project is in the public domain within the United States, and
+copyright and related rights in the work worldwide are waived through
+the [CC0 1.0 Universal public domain dedication](https://creativecommons.org/publicdomain/zero/1.0/).
+
+All contributions to this project will be released under the CC0
+dedication. By submitting a pull request, you are agreeing to comply
+with this waiver of copyright interest.
View
@@ -55,3 +55,6 @@ Additionally, the CLI exposes the following options:
-r, --formatter [verbose|json|string], Output formatter. Defaults to verbose.
-c, --config [rules], Path to a js file that exports an object describing additional rules.
```
+
+## Contributing
+Please see [CONTRIBUTING.md](./CONTRIBUTING.md).

0 comments on commit beb1eb9

Please sign in to comment.