Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Panos Sakkos committed Dec 28, 2015
1 parent 3efd4e2 commit b1101b9
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,14 @@ Open an Issue in order to file a bug or [suggest](https://github.com/PanosSakkos
If you want to close the issue:

1. Fork the repository and work on the fix or the feature. Don't forget to add you name in the CONTRIBUTORS file, no matter how small is your fix, even if it's a typo :wink:
2. Open a Pull Request with commits mentioning which issue are they fixing by adding in their description "Fixes #IssueNumber", in order to auto-resolve the issues after the Pull Request is merged into the master branch
3. Consider joining our [Gitter](https://gitter.im/PanosSakkos/personal-jekyll-theme) channel in order to make our communication easier
2. Open a Pull Request with commits mentioning which issue are they fixing by adding in their description "Fixes #IssueNumber", in order to auto-resolve the issues after the Pull Request is merged into the master branch.
3. In case you want to get your Pull Request in the master branch quickly, consider adding a screenshot of before and after your fix.
4. Consider joining our [Gitter](https://gitter.im/PanosSakkos/personal-jekyll-theme) channel in order to make our communication easier.

A few simple rules that have to be followed:

1. No tabs allowed, two spaces should be used instead
2. If you are adding a new feature, update the respective documentation post
3. Make sure to test your changes on the mobile rendering as well. It's as important as the desktop view
4. Make sure that after your changes the website is repsonsive, with respect to performance. There should be no lagging and make sure that this is the case when using it in a weak mobile client.
5. Squash your commits into one commit per ressolved issue
1. No tabs allowed, two spaces should be used instead.
2. If you are adding a new feature, update the respective documentation post.
3. Make sure to test your changes on the mobile rendering as well. It's as important as the desktop view.
4. Make sure that after your changes the website is responsive, with respect to performance. There should be no lagging and make sure that this is the case when using it in a weak mobile client.
5. Squash your commits into one commit per ressolved issue.

0 comments on commit b1101b9

Please sign in to comment.