-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
746e7f2
commit edfff21
Showing
1 changed file
with
54 additions
and
32 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,71 +1,93 @@ | ||
| # Contributing | ||
|
|
||
| Thank you for considering a contribution to the METS Reader/Writer! | ||
| This document outlines the change submission process for metsrw, along with our standards for new code contributions. | ||
| Following these guidelines helps us assess your changes faster and makes it easier for us to merge you submission! | ||
| This document outlines the change submission process for metsrw, along with our | ||
| standards for new code contributions. Following these guidelines helps us assess | ||
| your changes faster and makes it easier for us to merge you submission! | ||
|
|
||
| There are many ways to contribute: providing feedback on the [design & API](https://github.com/artefactual-labs/mets-reader-writer/wiki), submitting bug reports, or writing code which can be incorporated into metsrw itself. | ||
| There are many ways to contribute: providing feedback on the [design & API](https://github.com/artefactual-labs/mets-reader-writer/wiki), | ||
| submitting bug reports, or writing code which can be incorporated into metsrw | ||
| itself. | ||
|
|
||
| ## Table of contents | ||
|
|
||
| <!-- START doctoc generated TOC please keep comment here to allow auto update --> | ||
| <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> | ||
| **Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* | ||
|
|
||
| - [Contributing](#contributing) | ||
| - [Submitting bugs](#submitting-bugs) | ||
| - [Contribution standards](#contribution-standards) | ||
| - [Contributor's Agreement](#contributors-agreement) | ||
| - [Why do I have to sign a Contributor's Agreement?](#why-do-i-have-to-sign-a-contributors-agreement) | ||
| - [How do I send in an agreement?](#how-do-i-send-in-an-agreement) | ||
| - [Submitting bugs](#submitting-bugs) | ||
| - [Contribution standards](#contribution-standards) | ||
| - [Contributor's Agreement](#contributors-agreement) | ||
| - [Why do I have to sign a Contributor's Agreement?](#why-do-i-have-to-sign-a-contributors-agreement) | ||
| - [How do I send in an agreement?](#how-do-i-send-in-an-agreement) | ||
|
|
||
| <!-- END doctoc generated TOC please keep comment here to allow auto update --> | ||
|
|
||
| ## Submitting bugs | ||
|
|
||
| If you find a security vulnerability, do NOT open an issue. | ||
| Email security@artefactual.com instead. | ||
| Email <security@artefactual.com> instead. | ||
|
|
||
| All issues about Archivematica or related libraries should be filed in the [Archivematica Issues repository](https://github.com/archivematica/Issues/issues). | ||
| All issues about Archivematica or related libraries should be filed in the | ||
| [Archivematica Issues repository](https://github.com/archivematica/Issues/issues). | ||
|
|
||
| You can also post to the [Archivematica user forum](https://groups.google.com/forum/#!forum/archivematica). | ||
| A post to the mailing list is always welcome, especially if you're unsure if it's a bug or a local problem! | ||
| A post to the mailing list is always welcome, especially if you're unsure if | ||
| it's a bug or a local problem! | ||
|
|
||
| Useful questions to answer if you're having problems include: | ||
|
|
||
| * What version of metsrw are you using? | ||
| * How was it installed? | ||
| * What did you do to cause this bug to happen? | ||
| * What did you expect to happen? | ||
| * What did you see instead? | ||
| * Can you reproduce this reliably? | ||
| - What version of metsrw are you using? | ||
| - How was it installed? | ||
| - What did you do to cause this bug to happen? | ||
| - What did you expect to happen? | ||
| - What did you see instead? | ||
| - Can you reproduce this reliably? | ||
|
|
||
| ## Contribution standards | ||
|
|
||
| For more information on contribution guidelines and standards, see the CONTRIBUTING.md in the [Archivematica project](https://github.com/artefactual/archivematica). | ||
| For more information on contribution guidelines and standards, see the | ||
| CONTRIBUTING.md in the [Archivematica project](https://github.com/artefactual/archivematica). | ||
|
|
||
| ## Contributor's Agreement | ||
|
|
||
| In order for the Archivematica development team to accept any patches or code commits, contributors must first sign this [Contributor's Agreement](https://wiki.archivematica.org/images/e/e6/Archivematica-CLA-firstname-lastname-YYYY.pdf). | ||
| The Archivematica contributor's agreement is based almost verbatim on the [Apache Foundation](http://apache.org )'s individual [contributor license](http://www.apache.org/licenses/icla.txt). | ||
| In order for the Archivematica development team to accept any patches or code | ||
| commits, contributors must first sign this [Contributor's Agreement](https://wiki.archivematica.org/images/e/e6/Archivematica-CLA-firstname-lastname-YYYY.pdf). | ||
| The Archivematica contributor's agreement is based almost verbatim on the | ||
| [Apache Foundation](http://apache.org )'s individual [contributor license](http://www.apache.org/licenses/icla.txt). | ||
|
|
||
| If you have any questions or concerns about the Contributor's Agreement, please email us at agreement@artefactual.com to discuss them. | ||
| If you have any questions or concerns about the Contributor's Agreement, please | ||
| email us at <agreement@artefactual.com> to discuss them. | ||
|
|
||
| ### Why do I have to sign a Contributor's Agreement? | ||
|
|
||
| One of the key challenges for open source software is to support a collaborative development environment while protecting the rights of contributors and users over the long-term. | ||
| Unifying Archivematica copyrights through contributor agreements is the best way to protect the availability and sustainability of Archivematica over the long-term as free and open-source software. | ||
| In all cases, contributors who sign the Contributor's Agreement retain full rights to use their original contributions for any other purpose outside of Archivematica, while enabling Artefactual Systems, any successor organization which may eventually take over responsibility for Archivematica, and the wider Archivematica community to benefit from their collaboration and contributions in this open source project. | ||
|
|
||
| [Artefactual Systems](http://artefactual.com) has made the decision and has a proven track record of making our intellectual property available to the community at large. | ||
| By standardizing contributions on these agreements the Archivematica intellectual property position does not become too complicated. | ||
| This ensures our resources are devoted to making our project the best they can be, rather than fighting legal battles over contributions. | ||
| One of the key challenges for open source software is to support a collaborative | ||
| development environment while protecting the rights of contributors and users | ||
| over the long-term. | ||
| Unifying Archivematica copyrights through contributor agreements is the best way | ||
| to protect the availability and sustainability of Archivematica over the | ||
| long-term as free and open-source software. | ||
| In all cases, contributors who sign the Contributor's Agreement retain full | ||
| rights to use their original contributions for any other purpose outside of | ||
| Archivematica, while enabling Artefactual Systems, any successor organization | ||
| which may eventually take over responsibility for Archivematica, and the wider | ||
| Archivematica community to benefit from their collaboration and contributions in | ||
| this open source project. | ||
|
|
||
| [Artefactual Systems](http://artefactual.com) has made the decision and has a | ||
| proven track record of making our intellectual property available to the | ||
| community at large. | ||
| By standardizing contributions on these agreements the Archivematica | ||
| intellectual property position does not become too complicated. | ||
| This ensures our resources are devoted to making our project the best they can | ||
| be, rather than fighting legal battles over contributions. | ||
|
|
||
| ### How do I send in an agreement? | ||
|
|
||
| Please print out, read, sign, and scan the [contributor agreement](https://wiki.archivematica.org/images/e/e6/Archivematica-CLA-firstname-lastname-YYYY.pdf) and email it to agreement@artefactual.com | ||
| Please print out, read, sign, and scan the [contributor agreement](https://wiki.archivematica.org/images/e/e6/Archivematica-CLA-firstname-lastname-YYYY.pdf) | ||
| and email it to <agreement@artefactual.com> | ||
| Alternatively, you may send an original signed agreement to: | ||
|
|
||
| Artefactual Systems Inc. | ||
| 201 - 301 Sixth Street | ||
| New Westminster BC V3L 3A7 | ||
| Canada | ||
|
|