-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
CONTRIBUTING now refers to the AM one (#30)
Replace the CONTRIBUTING file with a reference to the main one, for ease of maintenance. Remove the currently unnecessary doctoc hook.
- Loading branch information
1 parent
cd984f5
commit 1aceb88
Showing
2 changed files
with
7 additions
and
114 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
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,109 +1,10 @@ | ||
# Contributing | ||
# Contributing to AMClient | ||
|
||
Thank you for considering a contribution to the AMClient! Archivematica's API | ||
client library. | ||
Thank you for your interest in making a contribution to AMClient. | ||
|
||
This document outlines the change submission process for AMClient, along with | ||
our standards for new code contributions. Following these guidelines helps us | ||
to assess your changes faster and makes it easier for us to merge your | ||
submission! | ||
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 AMClient. | ||
|
||
There are many ways to contribute: | ||
|
||
- submitting bug reports, | ||
- or writing code which can be incorporated into AMClient 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 --> | ||
|
||
- [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 | ||
<[email protected]> instead. | ||
|
||
Issues should be filed in our collective | ||
[Archivematica related issues repository][am-issues] | ||
|
||
For user support, clarification, or issues related to your deployment and use | ||
of AMClient you can post in our [Archivematica forum][am-forum]. A post to the | ||
mailing list is always welcome! | ||
|
||
Useful questions to answer if you're having problems include: | ||
|
||
- What version of AMClient are you using? | ||
- How was it installed? | ||
- How was AMClient being used when this issue occurred? | ||
- What was the expected outcome? | ||
- What was the actual outcome? | ||
- Can we reproduce this reliably? | ||
|
||
## Contribution standards | ||
|
||
For more information on contribution guidelines and standards, see the | ||
CONTRIBUTING.md in the [Archivematica project][contribute-to-am]. | ||
|
||
## 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][contributors-agreement]. | ||
|
||
The Archivematica contributor's agreement is based almost verbatim on the | ||
[Apache Foundation][apache-org]'s individual | ||
[contributor license][contributor-license]. | ||
|
||
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, or 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][af-systems] 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][contributors-agreement] and email it to | ||
<[email protected]>. Alternatively, you may send an original signed | ||
agreement to: | ||
|
||
```text | ||
Artefactual Systems Inc. | ||
201 - 301 Sixth Street | ||
New Westminster BC V3L 3A7 | ||
Canada | ||
``` | ||
|
||
[am-issues]: https://github.com/archivematica/issues | ||
[am-forum]: https://groups.google.com/forum/#!forum/archivematica | ||
[contribute-to-am]: https://github.com/artefactual/archivematica | ||
[contributors-agreement]: https://wiki.archivematica.org/images/2/25/Contributor_agreement.txt | ||
[apache-org]: http://apache.org | ||
[contributor-license]: http://www.apache.org/licenses/icla.txt | ||
[af-systems]: http://artefactual.com | ||
Any information specific to the AMClient project should be listed | ||
below. |