Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add section to contributing.md about adding words #217

Merged
merged 1 commit into from
Oct 5, 2018
Merged

Add section to contributing.md about adding words #217

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 15 additions & 4 deletions contributing.md
View file
Open in desktop
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