tCONTRIBUTING.rst - pism - [fork] customized build of PISM, the parallel ice sheet model (tillflux branch)
 (HTM) git clone git://src.adamsgaard.dk/pism
 (DIR) Log
 (DIR) Files
 (DIR) Refs
 (DIR) LICENSE
       ---
       tCONTRIBUTING.rst (2180B)
       ---
            1 Contributing to PISM
            2 ====================
            3 
            4 There are many ways you can contribute to PISM:
            5 
            6 - Fix typos, inaccuracies, and omissions in the manual.
            7 - Improve documentation of existing features.
            8 - Provide additional examples.
            9 - Add new tests for existing code.
           10 - Report issues with the code or documentation.
           11 - Fix bugs in PISM.
           12 - Implement new features.
           13 
           14 Please see `Contributing to PISM <pism-contributing_>`_ in PISM's manual for some guidelines.
           15 
           16 In summary: documentation and code contributions are preferred via pull requests to
           17 |pism-github-url|.
           18 
           19 #. `Fork PISM's repository. <github-help-fork_>`_
           20 #. Create a branch that will contain your changes.
           21 #. Implement proposed changes.
           22 
           23    a. Make changes to the code or documentation (or both).
           24    b. Test your changes.
           25    c. Add verification or regression tests (optional but **strongly encouraged**).
           26    d. Update documentation, if necessary.
           27    e. Update the change log ``CHANGES.rst``. If your contribution contains a bug fix,
           28       please describe the bug and its effects.
           29 
           30 #. `Create a pull request <github-pull-request-create_>`_ and make sure to `allow
           31    edits from maintainers. <github-pull-request-allow-edits_>`_
           32 
           33 If you are planning a large contribution we encourage you to open an issue at
           34 |pism-issues-url| or e-mail us at |pism-email| and interact with us frequently to ensure
           35 that your effort is well-directed.
           36 
           37 .. note::
           38 
           39    By submitting code, the contributor gives irretrievable consent to the redistribution
           40    and modification of the contributed source code as described in the PISM's open source
           41    license.
           42 
           43 .. URLs
           44 
           45 .. _github-help-fork: https://help.github.com/en/articles/fork-a-repo
           46 .. _github-pull-request-create: https://help.github.com/en/articles/creating-a-pull-request
           47 .. _github-pull-request-allow-edits: https://help.github.com/en/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork
           48 .. _pism-contributing: http://pism-docs.org/sphinx/contributing/
           49 
           50 .. |pism-github-url| replace:: https://github.com/pism/pism
           51 .. |pism-issues-url| replace:: https://github.com/pism/pism/issues
           52 .. |pism-email| replace:: uaf-pism@alaska.educ
           53 
           54 ..
           55    Local Variables:
           56    fill-column: 90
           57    End: