Connecteur COZY permettant de récupérer et stocker ses factures Enercoop.
Nelze vybrat více než 25 témat Téma musí začínat písmenem nebo číslem, může obsahovat pomlčky („-“) a může být dlouhé až 35 znaků.

CONTRIBUTING.md 4.7 KiB

před 6 roky
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135
  1. How to contribute to Cozy <APP_NAME>?
  2. ====================================
  3. Thank you for your interest in contributing to Cozy! There are many ways to contribute, and we appreciate all of them.
  4. Security Issues
  5. ---------------
  6. If you discover a security issue, please bring it to our attention right away! Please **DO NOT** file a public issue, instead send your report privately to security AT cozycloud DOT cc.
  7. Security reports are greatly appreciated and we will publicly thank you for it. We currently do not offer a paid security bounty program, but are not ruling it out in the future.
  8. Bug Reports
  9. -----------
  10. While bugs are unfortunate, they're a reality in software. We can't fix what we don't know about, so please report liberally. If you're not sure if something is a bug or not, feel free to file a bug anyway.
  11. Opening an issue is as easy as following [this link][issues] and filling out the fields. Here are some things you can write about your bug:
  12. - A short summary
  13. - What did you try, step by step?
  14. - What did you expect?
  15. - What did happen instead?
  16. - What is the version of the Cozy <APP_NAME>?
  17. Pull Requests
  18. -------------
  19. Please keep in mind that:
  20. - Pull-Requests point to the `master` branch
  21. - You need to cover your code and feature by tests
  22. - You may add documentation in the `/docs` directory to explain your choices if needed
  23. - We recommend to use [task lists][checkbox] to explain steps / features in your Pull-Request description
  24. - you do _not_ need to build app to submit a PR
  25. - you should update the Transifex source locale file if you modify it for your feature needs (see [Localization section in README][localization])
  26. ### Workflow
  27. Pull requests are the primary mechanism we use to change Cozy. GitHub itself has some [great documentation][pr] on using the Pull Request feature. We use the _fork and pull_ model described there.
  28. #### Step 1: Fork
  29. Fork the project on GitHub and [check out your copy locally][forking].
  30. ```
  31. $ git clone github.com/<USERNAME_GH>/<SLUG_GH>.git
  32. $ cd <SLUG_GH>
  33. $ git remote add fork git://github.com/yourusername/<SLUG_GH>.git
  34. ```
  35. #### Step 2: Branch
  36. Create a branch and start hacking:
  37. ```
  38. $ git checkout -b my-branch origin/master
  39. ```
  40. #### Step 3: Code
  41. Well, we think you know how to do that. Just be sure to follow the coding guidelines from the community ([standard JS][stdjs], comment the code, etc).
  42. #### Step 4: Test
  43. Don't forget to add tests and be sure they are green:
  44. ```
  45. $ cd <SLUG_GH>
  46. $ npm run test
  47. ```
  48. #### Step 5: Commit
  49. Writing [good commit messages][commitmsg] is important. A commit message should describe what changed and why.
  50. #### Step 6: Rebase
  51. Use `git rebase` (_not_ `git merge`) to sync your work from time to time.
  52. ```
  53. $ git fetch origin
  54. $ git rebase origin/master my-branch
  55. ```
  56. #### Step 7: Push
  57. ```
  58. $ git push -u fork my-branch
  59. ```
  60. Go to https://github.com/yourusername/<SLUG_GH> and select your branch. Click the 'Pull Request' button and fill out the form.
  61. Alternatively, you can use [hub] to open the pull request from your terminal:
  62. ```
  63. $ git pull-request -b master -m "My PR message" -o
  64. ```
  65. Pull requests are usually reviewed within a few days. If there are comments to address, apply your changes in a separate commit and push that to your branch. Post a comment in the pull request afterwards; GitHub doesn't send out notifications when you add commits.
  66. Writing documentation
  67. ---------------------
  68. Documentation improvements are very welcome. We try to keep a good documentation in the `/docs` folder. But, you know, we are developers, we can forget to document important stuff that look obvious to us. And documentation can always be improved.
  69. Translations
  70. ------------
  71. The Cozy <APP_NAME> is translated on a platform called [Transifex][tx]. [This tutorial][tx-start] can help you to learn how to make your first steps here. If you have any question, don't hesitate to ask us!
  72. Community
  73. ---------
  74. You can help us by making our community even more vibrant. For example, you can write a blog post, take some videos, answer the questions on [the forum][forum], organize new meetups, and speak about what you like in Cozy!
  75. [issues]: https://github.com/<USERNAME_GH>/<SLUG_GH>/issues/new
  76. [pr]: https://help.github.com/categories/collaborating-with-issues-and-pull-requests/
  77. [forking]: http://blog.campoy.cat/2014/03/github-and-go-forking-pull-requests-and.html
  78. [stdjs]: http://standardjs.com/
  79. [commitmsg]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
  80. [localization]: https://github.com/<USERNAME_GH>/<SLUG_GH>/blob/master/README.md#localization
  81. [hub]: https://hub.github.com/
  82. [tx]: https://www.transifex.com/cozy/
  83. [tx-start]: http://docs.transifex.com/getting-started/translators/
  84. [forum]: https://forum.cozy.io/