Skip to content

Commit

Permalink
CONTRIBUTING now refers to the AM one (#106)
Browse files Browse the repository at this point in the history
  • Loading branch information
eviau-artefactual authored Dec 18, 2023
1 parent 5ea8b85 commit 544312c
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 94 deletions.
8 changes: 0 additions & 8 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,3 @@ repos:
rev: v0.37.0
hooks:
- id: markdownlint
- repo: https://github.com/thlorenz/doctoc
rev: v2.2.0
hooks:
- id: doctoc
files: |
(?x)^(
CONTRIBUTING\.md
)
98 changes: 12 additions & 86 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,93 +1,19 @@
# Contributing
# Contributing to metsrw

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!
Thank you for your interest in making a contribution to metsrw.

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.
Since this project is used mostly in the general context of Archivematica, we
invite you to read the [Archivematica contributing guide](https://github.com/artefactual/archivematica/blob/qa/1.x/CONTRIBUTING.md)
to learn how to contribute to metsrw.

## Table of contents
Any information specific to the metsrw project should be listed
below.

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
------------------------------------

- [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)
## Design & API

<!-- END doctoc generated TOC please keep comment here to allow auto update -->
To provide feedback on the design and the API of metsrw, please refer yourself
to the [metsrw wiki].

## Submitting bugs

If you find a security vulnerability, do NOT open an issue.
Email <[email protected]> instead.

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!

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?

## Contribution standards

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).

If you have any questions or concerns about the Contributor's Agreement, please
email us at <[email protected]> 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.

### 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 <[email protected]>
Alternatively, you may send an original signed agreement to:

Artefactual Systems Inc.
201 - 301 Sixth Street
New Westminster BC V3L 3A7
Canada
[metsrw wiki]: https://github.com/artefactual-labs/mets-reader-writer/wiki

0 comments on commit 544312c

Please sign in to comment.