Skip to content

Commit

Permalink
README: Update contributing guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
caitlinelfring committed Oct 19, 2020
1 parent e0f9155 commit 9cbcf79
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 9 deletions.
4 changes: 2 additions & 2 deletions CODE_OF_CONDUCT.md
Expand Up @@ -68,9 +68,9 @@ members of the project's leadership.
## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
<https://www.contributor-covenant.org/faq>
21 changes: 14 additions & 7 deletions CONTRIBUTING.md
@@ -1,17 +1,23 @@
# Contributing

`woke` is an Open Source project that started when I realized there weren't any OSS tools to catch insensitive and non-inclusive language within source code on PRs.
`woke` is an Open Source project that started when I realized there weren't any OSS tools to catch insensitive and non-inclusive language within source code.

By participating in this project, you agree to abide by this projects [Code Of Conduct](./CODE_OF_CONDUCT.md).

`woke` is essentially a **language-agnostic linter**. I've taken my favorite parts of other linters
and used that as a guiding force. A few things I'll ask when contributing to this project:
and used that as a guiding force.

## Rules

A few rules for when contributing to this project:

* The goal of this project is to identify places within text files where better, inclusive language can be used. Please don't make contributions that don't push this goal forward.
* This project is not the forum to determine _what_ is inclusive language and _what_ is insensitive language. Contributions should be limited to providing consumers of `woke` the ability to make their own decisions regarding conscious language.
* You will participate in discussions that embody the spirit of this project and work towards building a healthy, supportive, and productive culture, and an environment where everyone feels welcome and included.
* If you're adding linter-based features, try to link to other well-known linters as a reference for why you want the feature added and what benefit it provides.
* Language-specific changes should be avoided at all costs. Please keep this project language-agnostic.
* Programming language-specific changes should be avoided at all costs. Please keep this project programming language-agnostic.

**If you do not abide by these rules, _this is your only warning_ and you will be blocked and reported immediately if I find your contributions do not embody the spirit of the project.**

## How to contribute

Expand All @@ -31,14 +37,15 @@ and used that as a guiding force. A few things I'll ask when contributing to thi

go test ./...

4. Push to your fork and submit a pull request. Explain the reason for your change and any background you can think of.
4. Push to your fork and submit a pull request. Fill out the Pull Request template thoroughly. I expect contributions to be thoughtful, have tests that are meaningful, and to be considerate of others who use this tool.

At this point you're waiting on us. Since this is a personal project, I make no guarantees
At this point you're waiting on the maintainers. Since this is a personal project, I make no guarantees
on response time, but I will do my absolute best because I care about this tool.
I may suggest some changes or improvements or alternatives.
I may suggest some changes or improvements or alternatives and reserve the right to reject your contribution if
I find it does not promote the spirit of this project.

Some things that will increase the chance that your pull request is accepted:

* Write good tests, coveralls will tell if if your PR reduced the overall code coverage.
* Write good tests, CI will tell if if your PR reduced the overall code coverage.
* Follow Go's [style guide](https://golang.org/doc/effective_go.html).
* Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).

0 comments on commit 9cbcf79

Please sign in to comment.