|
| 1 | +===================== |
| 2 | +Contributing to MOPAC |
| 3 | +===================== |
| 4 | + |
| 5 | +MOPAC is an open source project and, as such, contributions are welcome and appreciated. |
| 6 | +The standard, minimal legal stipulations apply: all contributions must be provided under |
| 7 | +the Apache 2.0 license and all contributors must agree to the DCO by using their real name |
| 8 | +and a valid email address in their git commit statements. |
| 9 | + |
| 10 | +How to contribute |
| 11 | +================= |
| 12 | + |
| 13 | +Please create a GitHub `Issue <https://github.com/openmopac/openmopac.github.io/issues/new>`_ for bug |
| 14 | +reports and feature requests. |
| 15 | + |
| 16 | +The preferred method of code contribution is to fork the project on |
| 17 | +`GitHub <https://github.com/openmopac/openmopac.github.io>`_, make your changes in a feature branch |
| 18 | +starting from the main branch, and then create a pull request. |
| 19 | + |
| 20 | +Open pull requests are also welcome, where a pull request is made before a contribution |
| 21 | +is ready to be merged, to open up an active dialogue between the core developers and the |
| 22 | +contributor about details of the contribution in development. This mode of operation is |
| 23 | +particularly useful when a pull request is linked with an issue articulating a problem |
| 24 | +that the pull request intends to solve. |
| 25 | + |
| 26 | +The Hugo-based website can be deployed from a fork by setting the build and deployment source to |
| 27 | +GitHub Actions in the Pages section of the repository Settings. The website rebuilds on push or trigger. |
| 28 | + |
| 29 | +What to contribute |
| 30 | +================== |
| 31 | + |
| 32 | +Most of the MOPAC website content is contained in the old manual and reference data webpages that |
| 33 | +were originally developed with Microsoft Frontpages or custom DOS scripts. Some of this information is |
| 34 | +out of date, and it is all embedded directly in static HTML rather than a modern format that separates |
| 35 | +content from style. |
| 36 | + |
| 37 | +The two long-term goals of MOPAC website development are to update old information and move content into |
| 38 | +the Hugo-based website. Contributions to these goals are welcome. |
| 39 | + |
| 40 | +The non-Hugo web content is located in the |
| 41 | +`static folder<https://github.com/openmopac/openmopac.github.io/tree/main/static>`_, |
| 42 | +a separate `manual repository<https://github.com/openmopac/Manual>`_, |
| 43 | +and a separate `reference data repository<https://github.com/openmopac/PM7_and_PM6-D3H4_accuracy>`_. |
| 44 | + |
| 45 | +Developer Certificate of Origin |
| 46 | +=============================== |
| 47 | + |
| 48 | +Contributors to MOPAC are assumed to agree with the Linux Foundation's |
| 49 | +`Developer Certificate of Origin <https://developercertificate.org/>`:: |
| 50 | + |
| 51 | + Developer Certificate of Origin |
| 52 | + Version 1.1 |
| 53 | + |
| 54 | + Copyright (C) 2004, 2006 The Linux Foundation and its contributors. |
| 55 | + 1 Letterman Drive |
| 56 | + Suite D4700 |
| 57 | + San Francisco, CA, 94129 |
| 58 | + |
| 59 | + Everyone is permitted to copy and distribute verbatim copies of this |
| 60 | + license document, but changing it is not allowed. |
| 61 | + |
| 62 | + |
| 63 | + Developer's Certificate of Origin 1.1 |
| 64 | + |
| 65 | + By making a contribution to this project, I certify that: |
| 66 | + |
| 67 | + (a) The contribution was created in whole or in part by me and I |
| 68 | + have the right to submit it under the open source license |
| 69 | + indicated in the file; or |
| 70 | + |
| 71 | + (b) The contribution is based upon previous work that, to the best |
| 72 | + of my knowledge, is covered under an appropriate open source |
| 73 | + license and I have the right under that license to submit that |
| 74 | + work with modifications, whether created in whole or in part |
| 75 | + by me, under the same open source license (unless I am |
| 76 | + permitted to submit under a different license), as indicated |
| 77 | + in the file; or |
| 78 | + |
| 79 | + (c) The contribution was provided directly to me by some other |
| 80 | + person who certified (a), (b) or (c) and I have not modified |
| 81 | + it. |
| 82 | + |
| 83 | + (d) I understand and agree that this project and the contribution |
| 84 | + are public and that a record of the contribution (including all |
| 85 | + personal information I submit with it, including my sign-off) is |
| 86 | + maintained indefinitely and may be redistributed consistent with |
| 87 | + this project or the open source license(s) involved. |
0 commit comments