diff --git a/README.md b/README.md index 269e275082..528938c5ed 100755 --- a/README.md +++ b/README.md @@ -86,6 +86,15 @@ docker run -p 3000:3000 -d susi.ai:1.0 ## Translations [Add translations in new language for SUSI.AI Web](https://github.com/fossasia/susi.ai/blob/master/docs/TRANSLATION.md) +## Contributions Best Practices + +### Commits + +- Write clear meaningful git commit messages (Do read [https://chris.beams.io/posts/git-commit/](https://chris.beams.io/posts/git-commit/)) +- Make sure your PR's description contains GitHub's special keyword references that automatically close the related issue when the PR is merged. (More info at [https://github.com/blog/1506-closing-issues-via-pull-requests](https://github.com/blog/1506-closing-issues-via-pull-requests) ) +- When you make very minor changes to a PR of yours (like for example fixing a failing Travis build or some small style corrections or minor changes requested by reviewers) make sure you squash your commits afterward so that you don't have an absurd number of commits for a very small fix. (Learn how to squash at [https://davidwalsh.name/squash-commits-git](https://davidwalsh.name/squash-commits-git) ) +- When you're submitting a PR for a UI-related issue, it would be really awesome if you add a screenshot of your change or a link to a deployment where it can be tested out along with your PR. It makes it very easy for the reviewers and you'll also get reviews quicker. + ## License This repository is under a GNU LESSER GENERAL PUBLIC LICENSE 2.1.