Home Explore Help
Sign In
yangck
/
django-jet
1
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Tree: 163cda7f55
Branches Tags
django-jet
/
docs
/
contribution.rst

contribution.rst 2.6 KB
History Raw

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465 
  1. Contributing
    2. 

  2. ============
    3. 

  3. 

  4. Django JET is open-source and every member of the community can contribute to it. Below are some guidelines on how
    5. 

  5. to help with the project and make it better.
    6. 

  6. 

  7. .. _rules:
    8. 

  8. 

  9. Rules
    10. 

  10. -----
    11. 

  11. 

  12. * Git master branch should always be stable
    13. 

  13. * All pull requests are made to git dev branch
    14. 

  14. * GPL (or similar) code is not eligible for inclusion
    15. 

  15. 

  16. Guidelines For Reporting An Issue/Feature
    17. 

  17. -----------------------------------------
    18. 

  18. 

  19. So you've found a bug or have a great idea for a feature. Here's the steps you should take
    20. 

  20. to help get it added/fixed in Django JET:
    21. 

  21. 

  22. * First check if there's an existing issue/pull request for this bug/feature. Issues can be found here
    23. 

  23.   https://github.com/geex-arts/django-jet/issues, PRs here https://github.com/geex-arts/django-jet/pulls
    24. 

  24. * If there isn't one there, please add an issue. The ideal report includes:
    25. 

  25. 

  26.   * A description of the problem/suggestion
    27. 

  27.   * How to reproduce the bug
    28. 

  28.   * If relevant including the versions of your:
    29. 

  29. 

  30.         * Python interpreter
    31. 

  31.         * Django
    32. 

  32.         * Django JET
    33. 

  33.         * Optionally of the other dependencies involved
    34. 

  34. 

  35.   * It would be great if you also make a pull request which solves your issue
    36. 

  36. 

  37. Guidelines For Contributing Code
    38. 

  38. --------------------------------
    39. 

  39. 

  40. If you're ready to contribute back some code/docs, the process should look like:
    41. 

  41. 

  42. * Fork the project on GitHub into your own account
    43. 

  43. * Clone your copy of Django JET to a separate folder
    44. 

  44. * Install it into your demo project using ``pip install -e PATH_TO_CLONED_JET``
    45. 

  45. * Make a new branch in git & commit your changes there
    46. 

  46. * Push your new branch up to GitHub
    47. 

  47. * Again, ensure there isn't already an issue or pull request out there on it. If there is and you feel you have
    48. 

  48.   a better fix, please take note of the issue number and mention it in your pull request
    49. 

  49. * Create a new pull request (based on your branch), including what the problem/feature is, versions of
    50. 

  50.   your software and referencing any related issues/pull requests
    51. 

  51. 

  52. In order to be merged into Django JET, contributions must have the following:
    53. 

  53. 

  54. * A solid patch that:
    55. 

  55. 

  56.   * is clear
    57. 

  57.   * works across all supported versions of Python/Django
    58. 

  58.   * follows the existing style of the code base (mostly PEP-8)
    59. 

  59. 

  60. * Desirably a test case that demonstrates the previous flaw that now passes with the included patch
    61. 

  61. * If it adds/changes a public API, it must also include documentation for those changes
    62. 

  62. * Must be appropriately licensed (see rules_)
    63. 

  63. 

  64. If your contribution lacks any of these things, they will have to be added by a core contributor before
    65. 

  65. being merged into Django JET proper, which may take time to get to.
    66.