Skip to content

Commit

Permalink
Add instructions for adding new words
Browse files Browse the repository at this point in the history
Closes GH-13.

Reviewed-by: Titus Wormer <[email protected]>
  • Loading branch information
mjalkio authored and wooorm committed Oct 18, 2018
1 parent 4c02b39 commit c2a5966
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,16 @@ any license information on that page.
Another list is based on the [`List of ethnic slurs` from
WikiPedia][racial-slurs].

## Contributing

Thanks, contributions are greatly appreciated! :+1:

New words should be added to [racial.txt][racial-list] if they are racial
slurs; all other profanities should be added to [rest.txt][rest-list].

After adding a word, run `npm test` to update [support.md][support]
and open a Pull Request.

## Related

* [buzzwords](https://github.com/words/buzzwords)
Expand Down Expand Up @@ -85,3 +95,7 @@ WikiPedia][racial-slurs].
[racial-slurs]: https://en.wikipedia.org/wiki/List_of_ethnic_slurs

[cuss]: https://github.com/wooorm/cuss

[racial-list]: script/racial.txt

[rest-list]: script/rest.txt

0 comments on commit c2a5966

Please sign in to comment.