Updated governance, contributing, and code of conduct
This commit is contained in:
Coraline
parent
db17c0c071
commit
b49434e6ee
2 changed files with 58 additions and 44 deletions
|
|
@ -57,11 +57,14 @@ Examples of representing our community include using an official e-mail address,
|
|||
posting via an official social media account, or acting as an appointed
|
||||
representative at an online or offline event.
|
||||
|
||||
## Reporting
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported
|
||||
by sending an email to `conduct at ethicalsource dot dev`.
|
||||
|
||||
## Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||
reported to the community leaders responsible for enforcement at coraline c/o
|
||||
idolhands dot com.
|
||||
reported to the community leaders responsible for enforcement at `conduct at ethicalsource dot dev`.
|
||||
|
||||
All complaints will be reviewed and investigated promptly and fairly.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,14 +1,63 @@
|
|||
# Contributing
|
||||
|
||||
Please feel free to submit pull requests or open issues to improve the language of this document
|
||||
Please feel free to submit pull requests or open issues to improve the language of this document
|
||||
or to provide additional [translations](https://www.contributor-covenant.org/translations).
|
||||
|
||||
You should also check the [issues](https://github.com/EthicalSource/contributor_covenant/issues)
|
||||
for the latest discussions involving the current and future versions of the Contributor Covenant.
|
||||
|
||||
### Build the website locally
|
||||
If you're new to contributing to projects hosted on Github, or need a refresher,
|
||||
you may find [How to make your first pull request on GitHub](https://www.freecodecamp.org/news/how-to-make-your-first-pull-request-on-github-3/)
|
||||
a useful resource.
|
||||
|
||||
## Adding a Project to the List of Adopters
|
||||
|
||||
* Fork the repository.
|
||||
* Add a new row to the [adopters.csv](static/adopters.csv) file,
|
||||
with the project name in the first column, and the project URL in the second column.
|
||||
* Open a pull request.
|
||||
|
||||
## We respect and appreciate different kinds of contributions.
|
||||
Ways that you can contribute:
|
||||
|
||||
### Community governance experts
|
||||
We value collaboration with contributors who bring their experience with code of
|
||||
conduct design or enforcement to continue to improve Contributor Covenant.
|
||||
|
||||
### Writers and copy editors
|
||||
We welcome contributions to improve the language of our site.
|
||||
|
||||
### Designers
|
||||
We welcome improvements to the design elements of our website or other ways that
|
||||
you can use your talents to improve [contributor-covenant.org](https://contributor-covenant.org).
|
||||
|
||||
### Translators and native speakers
|
||||
We're always looking for new localizations of the Contributor Covenant and are
|
||||
thankful to the volunteers who spend their time on translations.
|
||||
|
||||
We also rely on the contributions of native speakers in the form of review,
|
||||
edits, and suggestions.
|
||||
|
||||
If you are interested in doing a translation, please follow these steps:
|
||||
|
||||
1. Fork the repository and make a branch for your translation.
|
||||
1. If it's a new language, add it to `config.toml`,
|
||||
with a localized name and language code/optional region (e.g. `pt` or `pt-br`).
|
||||
1. Create a markdown file with your translation in `version/2/0/code_of_conduct.LANGUAGECODE.md`. (Underscores, not hyphens.)
|
||||
1. Open a pull request.
|
||||
1. We will put out a call to have one or more other native speakers review the translation.
|
||||
1. Collaborate until the translation is satisfactory.
|
||||
1. We will merge your translation!
|
||||
1. HTML and plain text versions are automatically generated from your markdown file.
|
||||
1. A link to your translation is automatically added to the translations page.
|
||||
|
||||
### Developers
|
||||
Code contributions to improve the development or operation of the [contributor-covenant.org](https://contributor-covenant.org)
|
||||
web site are welcome.
|
||||
|
||||
#### Build the website locally
|
||||
To build the website locally, first [install Hugo](https://gohugo.io/getting-started/installing)
|
||||
using your package manager of choice.
|
||||
using your package manager of choice.
|
||||
For example, on Debian/Ubuntu:
|
||||
```
|
||||
apt-get install hugo
|
||||
|
|
@ -24,38 +73,12 @@ If you are using [Homebrew](https://brew.sh) on macOS:
|
|||
brew install hugo
|
||||
```
|
||||
|
||||
### Start the server
|
||||
#### Start the server
|
||||
From the repository's root directory, start the development server:
|
||||
```
|
||||
hugo server -D
|
||||
```
|
||||
|
||||
## Translating
|
||||
|
||||
We're always looking for new localizations of the Contributor Covenant and are thankful to the volunteers who spend their time on translations.
|
||||
|
||||
If you are interested in doing a translation, please follow these steps:
|
||||
|
||||
1. Fork the repository and make a branch for your translation.
|
||||
1. If it's a new language, add it to `config.toml`,
|
||||
with a localized name and language code/optional region (e.g. `pt` or `pt-br`).
|
||||
1. Create a markdown file with your translation in `version/2/0/code_of_conduct.LANGUAGECODE.md`. (Underscores, not hyphens.)
|
||||
1. Open a pull request.
|
||||
1. We will put out a call to have one or more other native speakers review the translation.
|
||||
1. Collaborate until the translation is satisfactory.
|
||||
1. We will merge your translation!
|
||||
1. HTML and plain text versions are automatically generated from your markdown file.
|
||||
1. A link to your translation is automatically added to the translations page.
|
||||
|
||||
## Adding a Project to the List of Adopters
|
||||
|
||||
* Fork the repository.
|
||||
* Add a new row to the [adopters.csv](static/adopters.csv) file,
|
||||
with the project name in the first column, and the project URL in the second column.
|
||||
* Open a pull request.
|
||||
|
||||
# Site contributions
|
||||
|
||||
## Code Style
|
||||
- Use spaces for indentation
|
||||
- Order properties alphabetically
|
||||
|
|
@ -74,18 +97,6 @@ If you are interested in doing a translation, please follow these steps:
|
|||
- Breaking lines should be `1px solid #CCC`
|
||||
- Maintain [contrast](https://webaim.org/resources/contrastchecker/) to WCAG AA on normal text, WCAG AAA on large text
|
||||
- Use colors from [this palette](https://color.adobe.com/Royal-Purples-color-theme-7468845/edit/?copy=true&base=2&rule=Custom&selected=4&name=Copy%20of%20Royal%20Purples&mode=rgb&rgbvalues=0.2980392156862745,0.06666666666666667,0.3803921568627451,0.8,0.14901960784313725,0.1411764705882353,0.403921568627451,0,0.6784313725490196,0.5372549019607843,0.12156862745098039,0.6784313725490196,1,0.7137254901960784,0.08627450980392157&swatchOrder=0,1,2,3,4)
|
||||
- We also use `#FFF`, `#CCC`, and `#111` for main body text
|
||||
|
||||
```css
|
||||
.class {
|
||||
color: #4C1161;
|
||||
font-size: 1.1rem;
|
||||
}
|
||||
.second-class,
|
||||
.third-class {
|
||||
background-color: white;
|
||||
}
|
||||
```
|
||||
|
||||
### Markdown
|
||||
- Do not use fancy quotes, dashes, and such; the Markdown processor will handle that.
|
||||
|
|
|
|||
Loading…
Reference in a new issue