contribute.tmpl 6.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121
  1. <div class="pages bg">
  2. {{template "base/head" .}}
  3. <div class="pages head">
  4. <p class="text">🤝 Contribute to Gitote 🤝</p>
  5. </div>
  6. <div class="pages body">
  7. <center>
  8. <h2>Introduction</h2>
  9. </center>
  10. <p class="pages-small">
  11. We want to make it as easy as possible for Gitote users to become Gitote contributors, so we’ve
  12. created this guide to help you get started. We have multiple tracks to cater to people of varying
  13. experience levels.
  14. </p>
  15. <p class="pages-small">
  16. If you’re uncomfortable getting into open source development right away, you may want to consider
  17. the Documentation or Translation tracks. Documentation and Translation are both just as important as
  18. code, and we'd be happy to have your contributions.
  19. </p>
  20. <center class="pages-heading">
  21. <h2>Development</h2>
  22. </center>
  23. <p class="pages-small">
  24. As contributors and maintainers of this project, we pledge to respect all people who contribute through
  25. reporting issues, posting feature requests, updating documentation, submitting pull requests or patches,
  26. and other activities.
  27. </p>
  28. <p class="pages-small">
  29. We are committed to making participation in this project a harassment-free experience for everyone,
  30. regardless of level of experience, gender, gender identity and expression, sexual orientation, disability,
  31. personal appearance, body size, race, ethnicity, age, or religion.
  32. </p>
  33. <p class="pages-small">
  34. Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory
  35. comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional
  36. conduct.
  37. </p>
  38. <p class="pages-small">
  39. Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code,
  40. wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers
  41. who do not follow the Code of Conduct may be removed from the project team.
  42. </p>
  43. <p class="pages-small">
  44. This code of conduct applies both within project spaces and in public spaces when an individual is
  45. representing the project or its community.
  46. </p>
  47. <p class="pages-small">
  48. Instances of abusive, harassing, or otherwise unacceptable behavior can be reported by emailing
  49. <code class="code">contact@gitote.in</code>.
  50. </p>
  51. <p class="pages-small">
  52. This Code of Conduct is adapted from the <a href="http://contributor-covenant.org/">Contributor Covenant</a> version 1.1.0, available at
  53. <a href="http://contributor-covenant.org/version/1/1/0/">http://contributor-covenant.org/version/1/1/0/</a>.
  54. </p>
  55. <center class="pages-heading">
  56. <h2>Documentation</h2>
  57. </center>
  58. <p class="pages-small">
  59. These instructions are for development of Gitote.in specifically. Please note that use of the
  60. Gitote Development Kit is currently experimental on Windows. macOS or Linux are recommended for the best
  61. contribution experience.
  62. </p>
  63. <ol>
  64. <li class="pages-small">
  65. Download and setup the <a href="https://gitote.in/gitote/gitote-development-kit">Gitote Development
  66. Kit</a>, see the <a href="https://gitote.in/gitote/gitote-development-kit/blob/master/README.md">GDK
  67. README</a> for instructions on setting it up and
  68. <a href="https://gitote.in/gitote/gitote-development-kit/blob/master/doc/howto/troubleshooting.md">
  69. Troubleshooting</a> if you get stuck.
  70. </li>
  71. <li class="pages-small">Fork the Gitote project.</li>
  72. <li class="pages-small">
  73. Choose an issue to work on. * You can find easy issues by
  74. <a href="https://gitote.in/gitote/gitote/issues?label_name%5B%5D=Accepting+merge+requests">
  75. looking at issues labeled Accepting Merge Requests and sorting issues by weight</a>, low-weight issues will be the
  76. easiest to accomplish.
  77. <ul>
  78. <li class="pages-small">
  79. Be sure to comment and verify no one else is working on the issue, and to make sure
  80. we’re still interested in a given contribution.
  81. </li>
  82. <li class="pages-small">
  83. You may also want to comment and ask for help if you’re new
  84. or if you get stuck. We’re happy to help!
  85. </li>
  86. </ul>
  87. <li class="pages-small">Add the feature or fix the bug you’ve chosen to work on.</li>
  88. <li class="pages-small">
  89. Open a merge request. The earlier you open a merge request, the sooner you can get feedback. You can
  90. mark it as a Work in Progress to signal that you’re not done yet.
  91. </li>
  92. <li class="pages-small">
  93. Add tests and documentation if needed, as well as
  94. <a href="https://docs.gitlab.com/ee/development/changelog.html">a changelog entry</a>.
  95. </li>
  96. <li class="pages-small">Make sure the test suite is passing.</li>
  97. <li class="pages-small">
  98. Wait for a reviewer. You’ll likely need to change some things once the reviewer has completed a code review for
  99. your merge request. You may also need multiple reviews depending on the size of the change.
  100. </li>
  101. <li class="pages-small">Get your changes merged!</li>
  102. </ol>
  103. <p class="pages-small">
  104. For more information, please see the <a href="/developers">Developer Documentation.</a>
  105. </p>
  106. </div>
  107. {{template "base/footer" .}}
  108. </div>