/ CONTRIBUTING.md
CONTRIBUTING.md
1 # Contributing 2 3 Please feel free to submit pull requests or open issues to improve the language of this document 4 or to provide additional [translations](https://www.contributor-covenant.org/translations). 5 6 You should also check the [issues](https://github.com/EthicalSource/contributor_covenant/issues) 7 for the latest discussions involving the current and future versions of the Contributor Covenant. 8 9 If you're new to contributing to projects hosted on Github, or need a refresher, 10 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/) 11 a useful resource. 12 13 ## Adding a Project to the List of Adopters 14 15 * Fork the repository. 16 * Add a new row to the [adopters.csv](static/adopters.csv) file, 17 with the project name in the first column, and the project URL in the second column. 18 * Open a pull request. 19 20 ## We respect and appreciate different kinds of contributions. 21 Ways that you can contribute: 22 23 ### Community governance experts 24 We value collaboration with contributors who bring their experience with code of 25 conduct design or enforcement to continue to improve Contributor Covenant. 26 27 ### Writers and copy editors 28 We welcome contributions to improve the language of our site. 29 30 ### Designers 31 We welcome improvements to the design elements of our website or other ways that 32 you can use your talents to improve [contributor-covenant.org](https://contributor-covenant.org). 33 34 ### Translators and native speakers 35 We're always looking for new localizations of the Contributor Covenant and are 36 thankful to the volunteers who spend their time on translations. 37 38 We also rely on the contributions of native speakers in the form of review, 39 edits, and suggestions. 40 41 If you are interested in doing a translation, please follow these steps: 42 43 1. Fork the repository and make a branch for your translation. 44 1. If it's a new language, add it to `config.toml`, 45 with a localized name and language code/optional region (e.g. `pt` or `pt-br`). 46 1. Create a markdown file with your translation in `version/2/0/code_of_conduct.LANGUAGECODE.md`. (Underscores, not hyphens.) 47 1. Open a pull request. 48 1. We will put out a call to have one or more other native speakers review the translation. 49 1. Collaborate until the translation is satisfactory. 50 1. We will merge your translation! 51 1. HTML and plain text versions are automatically generated from your markdown file. 52 1. A link to your translation is automatically added to the translations page. 53 54 ### Developers 55 Code contributions to improve the development or operation of the [contributor-covenant.org](https://contributor-covenant.org) 56 web site are welcome. 57 58 #### Build the website locally 59 To build the website locally, first [install Hugo](https://gohugo.io/getting-started/installing) 60 using your package manager of choice. 61 For example, on Debian/Ubuntu: 62 ``` 63 apt-get install hugo 64 ``` 65 66 If you are using Arch Linux: 67 ``` 68 pacman -S hugo 69 ``` 70 71 If you are using [Homebrew](https://brew.sh) on macOS: 72 ``` 73 brew install hugo 74 ``` 75 76 #### Start the server 77 From the repository's root directory, start the development server: 78 ``` 79 hugo server -D 80 ``` 81 82 ## Code Style 83 - Use spaces for indentation 84 - Order properties alphabetically 85 86 ### HTML 87 - Include `alt` attribute for all images 88 - Include `title` attribute for all links 89 - Close all your tags properly 90 91 ### CSS 92 - Try to use classes instead of IDs unless things are absolutely unique 93 - One selector per line 94 - Support IE 9 and above 95 - Use `rem` over `em` or `px` 96 - Capitalize hexadecimal 97 - Breaking lines should be `1px solid #CCC` 98 - Maintain [contrast](https://webaim.org/resources/contrastchecker/) to WCAG AA on normal text, WCAG AAA on large text 99 - 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) 100 101 ### Markdown 102 - Do not use fancy quotes, dashes, and such; the Markdown processor will handle that.