Skip to content

Latest commit

 

History

History
78 lines (53 loc) · 2.84 KB

CONTRIBUTING.rst

File metadata and controls

78 lines (53 loc) · 2.84 KB

Contributing to ParMOO

Contributions of source code, documentations, and fixes are happily accepted via GitHub pull request to

https://github.com/parmoo/parmoo-solver-farm

If you are planning a contribution, reporting bugs, or suggesting features, we encourage you to discuss the concept by opening a github issue at

https://github.com/parmoo/parmoo-solver-farm/issues

or by emailing [email protected] and interacting with us to ensure that your effort is well-directed.

Contribution Process

Since we encourage the inclusion of results with each solver, ParMOO's solver farm must be protected to prevent overfilling the git history with corrections to data files. Contributors should typically branch from, and make pull requests to, the main branch. Pull requests may be made from a fork.

Issues can be raised at

https://github.com/parmoo/parmoo-solver-farm/issues

Issues may include reporting bugs or suggested features.

When a branch closes a related issue, the pull request message should include the phrase "Closes #N," where N is the issue number.

All pull requests to main must be reviewed by at least one administrator.

We will typically only approve pull requests for peer-reviewed work to avoid over-filling the git history.

Developer's Certificate

ParMOO is distributed under a 3-clause BSD license (see LICENSE). Unless otherwise mentioned in its specific subdirectory, you may assume that each solver carries the same license.

The act of submitting a pull request or patch will be understood as an affirmation of the following:

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.