I will be accepting up to one pull request per day on this project.
View the result at thepracticaldev.github.io/1pr.
- As one does at three o'clock in the morning, I started a funky side project.
- 1pr Day 3: Added styles and a project contributor list
- Having trouble integrating gitter into 1pr
- Fork the repository
- Add something awesome
- Create a pull request
- Hope you get picked
When contributing, please try to follow the coding standards so we have nice looking code that's easy to follow for everyone.
Where possible, use an editor (or a plugin for your editor) that supports editorconfig.
The editorconfig file should set your editor to the following settings automatically:
- UTF-8 charset
- Unix-style line breaks
- End file with a new line
- No trailing whitespace before a line break
- Use tabs for indentation
Tab width is not defined in the editorconfig, so each deveveloper can set their editor's tab width to what they're most comfortable with.
- Add comments to your code where necessary. The project should be accessible for devs of all experience and skill levels. Better to have too many comments, than none at all.
- Whitespace is not the enemy! A couple of empty lines between blocks of code can really improve readability.
- Use semicolons (even through they're not strictly necessary). It's good practice!
- Use
letandconstwhere applicable, to keep the scope of your variables specific. Don't know what scope is or whatletdoes? Check out this article. - Use
lowerCamelCasefor variable names (notsnake_case)