Skip to content

Latest commit

 

History

History
57 lines (43 loc) · 2.13 KB

CONTRIBUTING.rst

File metadata and controls

57 lines (43 loc) · 2.13 KB
Raw

Contributing to PISM

There are many ways you can contribute to PISM:

  • Fix typos, inaccuracies, and omissions in the manual.
  • Improve documentation of existing features.
  • Provide additional examples.
  • Add new tests for existing code.
  • Report issues with the code or documentation.
  • Fix bugs in PISM.
  • Implement new features.

Please see Contributing to PISM in PISM's manual for some guidelines.

In summary: documentation and code contributions are preferred via pull requests to https://github.com/pism/pism.

  1. Fork PISM's repository.
  2. Create a branch that will contain your changes.
  3. Implement proposed changes.
    1. Make changes to the code or documentation (or both).
    2. Test your changes.
    3. Add verification or regression tests (optional but strongly encouraged).
    4. Update documentation, if necessary.
    5. Update the change log CHANGES.rst. If your contribution contains a bug fix, please describe the bug and its effects.
  4. Create a pull request and make sure to allow edits from maintainers.

If you are planning a large contribution we encourage you to open an issue at https://github.com/pism/pism/issues or e-mail us at [email protected] and interact with us frequently to ensure that your effort is well-directed.

Note

By submitting code, the contributor gives irretrievable consent to the redistribution and modification of the contributed source code as described in the PISM's open source license.