-
Notifications
You must be signed in to change notification settings - Fork 127
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Clarify current contributing process (#1848)
- Loading branch information
1 parent
88b41d0
commit 44a2b76
Showing
1 changed file
with
32 additions
and
59 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,72 +1,50 @@ | ||
| # Contributing | ||
|
|
||
| Thank you for your interest in contributing to the Access to Memory (AtoM) | ||
| project! Third-party patches and community development help keep the AtoM | ||
| project vibrant and responsive to our users' needs. We hope to simplify the | ||
| contribution process as much as possible. We have posted some simple | ||
| guidelines to help you get started. Please review these guidelines before | ||
| reporting issues or making pull requests to the AtoM project. | ||
| project! Patches and other forms of community development help make the | ||
| AtoM project vibrant and responsive to users' needs. Here are the guidelines | ||
| on reporting issues and making pull requests to the AtoM project. | ||
|
|
||
| Thanks! | ||
|
|
||
| **Contents** | ||
|
|
||
| * [Reporting a security vulnerabilitiy](#security-vulnerability) | ||
| * [Reporting general bugs](#reporting-general-bugs) | ||
| * [Contributing code](#contributing-code) | ||
| * [Contributing documentation and translations](#contributing-documentation-and-translations) | ||
|
|
||
| ## Reporting general bugs | ||
|
|
||
| **If you are reporting a security vulnerability**, please consult the | ||
| instructions in our SECURITY.md file before proceeding. If you have discovered | ||
| an issue in AtoM that is **not** related to a security vulnerability, we | ||
| welcome your reports. | ||
|
|
||
| You can report general bugs in two ways: | ||
|
|
||
| * By creating a new post in the [AtoM user forum](https://groups.google.com/forum/#!forum/ica-atom-users) | ||
| * By [opening an issue](https://github.com/artefactual/atom/issues) in our | ||
| GitHub repository | ||
|
|
||
| Please be sure to include all the information we will need to reproduce the | ||
| issue locally. This includes: | ||
| ## Security vulnerability | ||
|
|
||
| * The version of AtoM you are using | ||
| * Basic information about your installation environment, including PHP, MySQL, | ||
| Elasticsearch, and operating system versions | ||
| * Steps to reproduce the issue | ||
| * The resulting error or vulnerability and the expected outcome | ||
| * If there are any error logs related to the issue, please include the | ||
| relevant parts as well | ||
| **If you are reporting a security vulnerability**, refer yourself to the | ||
| [SECURITY.md](./SECURITY.md) document. | ||
|
|
||
| You can find useful tips on how to find this information in the Troubleshooting | ||
| page in our documentation: | ||
| ## Reporting general bugs | ||
|
|
||
| * https://www.accesstomemory.org/docs/latest/admin-manual/maintenance/troubleshooting/ | ||
| If you have discovered an issue in AtoM, we welcome your reports. | ||
|
|
||
| Note as well that, as a community-driven open source project, we depend on our | ||
| community to be able to maintain and develop AtoM. We are committed to | ||
| including as many bug fixes as we can in each new release, but a confirmed | ||
| report is not enough alone to guarantee that a fix will be included in the | ||
| next release. If your institution is interested in sponsoring a fix, feel free | ||
| to contact Artefactual Systems for an estimate - all sponsored development | ||
| will be included in the next public release. For more information on how we | ||
| develop and maintain AtoM, please see: | ||
| Start by doing a search on [AtoM user forum](https://groups.google.com/forum/#!forum/ica-atom-users) | ||
| and in the [AtoM GitHub issues](https://github.com/artefactual/atom/issues) | ||
| to see if your question has been considered in the past. | ||
|
|
||
| * https://wiki.accesstomemory.org/Development/Philosophy | ||
| If you are sure that the issue you have is a bug, please open an issue | ||
| on GitHub. If not, feel welcome to open a thread in the AtoM user forum. | ||
|
|
||
| We also welcome pull requests to fix issues! | ||
| The [Troubleshooting guide](https://www.accesstomemory.org/docs/latest/admin-manual/maintenance/troubleshooting/) | ||
| contains useful tips on how to find information needed to open an issue, | ||
| such as the [version of AtoM](https://www.accesstomemory.org/docs/latest/user-manual/administer/settings/#application-version), | ||
| accessing [errors logs and debug mode](https://www.accesstomemory.org/docs/latest/admin-manual/maintenance/troubleshooting/#troubleshooting-logs-debug), | ||
| and other information needed to [get support](https://www.accesstomemory.org/docs/latest/admin-manual/maintenance/troubleshooting/#getting-support). | ||
|
|
||
| ## Contributing code | ||
|
|
||
| If you're considering contributing code to the project, please read our | ||
| contribution page and familiarize yourself with our coding style and code | ||
| review guidelines. | ||
| Please read our contribution page and familiarize yourself with our coding | ||
| style and code review guidelines. | ||
|
|
||
| * Find out more about our Code Review process here: [Code review](https://wiki.accesstomemory.org/Development/Code_review) | ||
| * Learn about our Coding standards here: [Coding standard](https://wiki.accesstomemory.org/Development/Coding_standard) | ||
| * Find information about our Code repository here: [Code repository](https://wiki.accesstomemory.org/Resources/Code_repository) | ||
| * Read about our Testing strategies here: [Testing](https://wiki.accesstomemory.org/Development/Testing) | ||
| * Access the [Contributor's Agreement here](https://wiki.accesstomemory.org/wiki/Development/Contribute_code#Copyright_and_license) | ||
| * Find out more about our [Code review](https://wiki.accesstomemory.org/Development/Code_review) | ||
| * Learn about our [Coding standard](https://wiki.accesstomemory.org/Development/Coding_standard) | ||
| * Find information about our [Code repository](https://wiki.accesstomemory.org/Resources/Code_repository) | ||
| * Read about our [Testing strategies](https://wiki.accesstomemory.org/Development/Testing) | ||
|
|
||
| We ask that all code contributors complete and return a signed Contributor’s | ||
| Agreement before we will review and merge your contribution. This is to | ||
|
|
@@ -79,21 +57,16 @@ to: | |
| * [[email protected]](mailto:[email protected]) | ||
|
|
||
| **If you are working on a larger pull request and/or new feature**, please be | ||
| sure to read this page: | ||
|
|
||
| * https://wiki.accesstomemory.org/Development/Recommendations | ||
| sure to read [our recommendations](https://wiki.accesstomemory.org/Development/Recommendations) | ||
|
|
||
| ## Contributing documentation and translations | ||
|
|
||
| If you would like to help us improve the AtoM documentation, please see our | ||
| wiki for more information: | ||
|
|
||
| * https://wiki.accesstomemory.org/Resources/Documentation | ||
| If you would like to [help us improve the AtoM documentation, please see our | ||
| wiki](https://wiki.accesstomemory.org/Resources/Documentation) for more information. | ||
|
|
||
| Additionally, with each new AtoM release we include user interface | ||
| translations generously provided by our volunteer translator community. To | ||
| learn more, including how you can help contribute translations, please see: | ||
|
|
||
| * https://wiki.accesstomemory.org/Resources/Translation | ||
| translations generously provided by our volunteer translator community. Here is the | ||
| information on [how to help contribute translations](https://wiki.accesstomemory.org/Resources/Translation) | ||
|
|
||
| Thanks! | ||
|
|
||