Contribute.md.erb 1.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
  1. # Contribute
  2. _For security issues, please read the `Security.md` file._
  3. [Describe welcomed contributions]
  4. ## Setup
  5. [How to setup local development environment.]
  6. [Brief file, and sub-directories, description.]
  7. ## Report Priority
  8. As a solo maintainer, reports get prioritize according to
  9. - Severity
  10. - Number of users affected
  11. ## Issue Guidelines
  12. Post a complete description of the issue using this template
  13. ```markdown
  14. # Issue Title
  15. ## I did this
  16. [self-contained example]
  17. ## I expected
  18. [previous behavior]
  19. ## Instead got
  20. [backtrace or behavior description]
  21. ## Already looked into
  22. [quote documentation, closed issues or other forums]
  23. ## Project version
  24. [project -V]
  25. ## Dependency versions
  26. [OS, and other relevant dependencies]
  27. ```
  28. Please make a documentation related pull request based on your question,
  29. it's answer, and related discussion when appropriate. Alternatively,
  30. submit bugs as test cases.
  31. ## Patch Guidelines
  32. _Patches can be delivered as pull requests, or emails._
  33. - All patches are contributed under `License.md`. Do not submit a patch
  34. if that isn't the case.
  35. - Include tests for substantial bug fixes.
  36. - Follow the style conventions of the surrounding code.
  37. - Strip trailing white space.
  38. - Update/add documentation.
  39. ## Code of Conduct
  40. This code of conduct applies to all of the project's current, and future,
  41. collaborative spaces, such as the hosted source code, it's issue tracker,
  42. and official mirrors.
  43. - Discussion should be limited to the project, and related technologies.
  44. - Participants must ensure their language, and actions, are free of
  45. personal attacks and remarks disparaging to anyone.
  46. - Behaviour which can be reasonably considered harassment will not be
  47. tolerated, and may result in being banned from these spaces.
  48. You may report any violation to the project maintainer at
  49. `:TODO: at example dot com`.