You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

48 lines
1.9 KiB

10 years ago
  1. # Contributing to Gogs
  2. Want to hack on Gogs? Awesome! Here are instructions to get you
  3. started. They are probably not perfect, please let us know if anything
  4. feels wrong or incomplete.
  5. ## Contribution guidelines
  6. ### Pull requests are always welcome
  7. We are always thrilled to receive pull requests, and do our best to
  8. process them as fast as possible. Not sure if that typo is worth a pull
  9. request? Do it! We will appreciate it.
  10. If your pull request is not accepted on the first try, don't be
  11. discouraged! If there's a problem with the implementation, hopefully you
  12. received feedback on what to improve.
  13. We're trying very hard to keep Gogs lean and focused. We don't want it
  14. to do everything for everybody. This means that we might decide against
  15. incorporating a new feature.
  16. ### Discuss your design on the mailing list
  17. We recommend discussing your plans [on the mailing
  18. list](https://groups.google.com/forum/#!forum/gogits)
  19. before starting to code - especially for more ambitious contributions.
  20. This gives other contributors a chance to point you in the right
  21. direction, give feedback on your design, and maybe point out if someone
  22. else is working on the same thing.
  23. We may close your pull request if not first discussed on the mailing
  24. list. We aren't doing this to be jerks. We are doing this to prevent
  25. people from spending large amounts of time on changes that may need
  26. to be designed or architected in a specific way, or may not align with
  27. the vision of the project.
  28. ### Create issues...
  29. Any significant improvement should be documented as [a GitHub
  30. issue](https://github.com/gogits/gogs/issues) before anybody
  31. starts working on it.
  32. ### ...but check for existing issues first!
  33. Please take a moment to check that an issue doesn't already exist
  34. documenting your bug report or improvement proposal. If it does, it
  35. never hurts to add a quick "+1" or "I have this problem too". This will
  36. help prioritize the most common problems and requests.