Skip to content

Commit

Permalink
Add guidelines for contributing.
Browse files Browse the repository at this point in the history
  • Loading branch information
benmwebb committed Feb 8, 2016
1 parent bb04ba6 commit a18201e
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,30 @@
How to contribute to PMI
========================

(Note that PMI, as a submodule of IMP, follows the same contribution guidelines
as IMP itself, below.)

IMP is open source software, and we welcome contributions! These contributions
could include
- Reporting or fixing a bug
- Fixing a typo in the comments or documentation
- Adding a new function, class, or module to IMP
- Publishing your protocol for applying IMP to a biological system

To report a bug, please [open an issue at GitHub](https://github.com/salilab/pmi/issues).
See [the IMP manual](https://integrativemodeling.org/nightly/doc/manual/bugs.html)
for more information.

The easiest way to fix a typo in the comments or documentation is to use
the edit icon at the top of each page in GitHub.

To add or change code in PMI, fork the repository and then open a pull request.
Code should conform to our
[coding conventions](https://integrativemodeling.org/nightly/doc/manual/code_conventions.html)
and
[naming and interface conventions](https://integrativemodeling.org/nightly/doc/manual/conventions.html).
See the [IMP manual](https://integrativemodeling.org/nightly/doc/manual/developing.html)
for more detail.

To publish your protocol for applying IMP to a biological system, please
see the [IMP manual](https://integrativemodeling.org/nightly/doc/manual/biosystem.html).

0 comments on commit a18201e

Please sign in to comment.