Skip to content

Commit

Permalink
Add section on adding new words to contributing.md
Browse files Browse the repository at this point in the history
Related-to GH-195.
Related-to GH-212.

Closes GH-217.

Reviewed-by: Titus Wormer <tituswormer@gmail.com>
  • Loading branch information
MrBenJ authored and wooorm committed Oct 5, 2018
1 parent 5548330 commit 63f83bd
Showing 1 changed file with 15 additions and 4 deletions.
19 changes: 15 additions & 4 deletions contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ let us know!
* [Give feedback on issues](#give-feedback-on-issues)
* [Write code](#write-code)
* [Website contributions](#website-contributions)
* [Adding profanities and other words](#adding-profanities-and-other-words)
* [Submitting an issue](#submitting-an-issue)
* [Submitting a pull request](#submitting-a-pull-request)
* [Resources](#resources)
Expand Down Expand Up @@ -86,13 +87,21 @@ prevent you from doing unnecessary work.

### Website contributions

There are ways in which our [website][website] can be improved as well, and
There are ways in which our [website][website] can be improved as well, and
we are open to contributions.
Switch to the [`website`][website-branch] branch (with `git checkout website`)
and start contributing!
Changes made to the [`src`][src-folder] folder are automatically
Switch to the [`website`][website-branch] branch (with `git checkout website`)
and start contributing!
Changes made to the [`src`][src-folder] folder are automatically
built to the [`dest`][dest-folder] folder.

### Adding profanities and other words

If you have profanities, insensitive words, and/or any other additions to add
to our repository, you’ll need to make a PR to [`profanities`][profanities],
and then [`cuss`][cuss] after the former is released. The words will
automatically be added into [`retext-profanities`][profanities] and Alex as
well.

## Submitting an issue

* The issue tracker is for issues
Expand Down Expand Up @@ -129,6 +138,8 @@ built to the [`dest`][dest-folder] folder.

[coc]: https://github.com/get-alex/alex/blob/master/code-of-conduct.md

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

[unified]: https://github.com/unifiedjs/unified

[remark]: https://github.com/remarkjs/remark
Expand Down

0 comments on commit 63f83bd

Please sign in to comment.