|
1 |
| -# Contributing to Archive of Our Own |
| 1 | +# Contributing to OTW-Archive |
| 2 | + |
| 3 | +## Reporting bugs |
| 4 | + |
| 5 | +We maintain a [Jira issue tracker](https://otwarchive.atlassian.net) for developers, |
| 6 | +and a [list of Known Issues](https://archiveofourown.org/known_issues) for |
| 7 | +[Archive of Our Own](https://archiveofourown.org) users, neither of which are |
| 8 | +publicly editable. |
| 9 | + |
| 10 | +If you need help using the site, or want to report an issue you have found, |
| 11 | +please [contact the AO3 Support team](https://archiveofourown.org/support). |
2 | 12 |
|
3 |
| -## Contributing code |
4 | 13 |
|
5 |
| -### Report a bug |
| 14 | +## Reporting security issues |
6 | 15 |
|
7 |
| -We have a [list of known issues](https://archiveofourown.org/known_issues). |
8 |
| -If you have a problem that you don't see on that list, please send a bug report |
9 |
| -via the [Support and Feedback Form](https://archiveofourown.org/support). |
| 16 | +Please refer to [SECURITY.md](https://github.com/otwcode/otwarchive/blob/master/SECURITY.md). |
10 | 17 |
|
11 |
| -### Pick an issue to work on |
12 | 18 |
|
13 |
| -You will find our [list of approved issues on JIRA](https://otwarchive.atlassian.net/projects/AO3/issues). |
| 19 | +## Updating documentation |
14 | 20 |
|
15 |
| -We regret that we cannot accept pull requests for issues we haven't already logged, with the exception of documentation |
16 |
| -or spelling corrections. |
| 21 | +Our [development wiki](https://github.com/otwcode/otwarchive/wiki) is publicly |
| 22 | +editable. Unless a page says at the top that it should only be edited by |
| 23 | +official OTW volunteers, please feel free to make changes! |
17 | 24 |
|
18 |
| -### Resolve the issue |
19 | 25 |
|
20 |
| -Consult our [Developer Documentation](https://github.com/otwcode/otwarchive/wiki) on how to set up a local development |
21 |
| -environment so you can work on the Archive code. |
| 26 | +## Suggesting new features |
22 | 27 |
|
23 |
| -### Submit your pull request |
| 28 | +Please [contact the AO3 Support team](https://archiveofourown.org/support). |
24 | 29 |
|
25 |
| -Please read the checklist on [our pull request template](https://github.com/otwcode/otwarchive/blob/master/.github/PULL_REQUEST_TEMPLATE.md) |
26 |
| -for the steps you need to perform to make sure we can accept your pull request. |
27 | 30 |
|
28 |
| -### Action comments on your pull request |
| 31 | +## Contributing code |
| 32 | + |
| 33 | +**We only accept pull requests for issues we have already added to [Jira](https://otwarchive.atlassian.net)**, |
| 34 | +with the exception of spelling corrections and documentation improvements |
| 35 | +(e.g. any Markdown files). |
29 | 36 |
|
30 |
| -When we review your pull request, we will make comments on GitHub. Please make sure you read these carefully and apply |
31 |
| -the suggestions! |
| 37 | +Please check out our development wiki for more information on: |
32 | 38 |
|
33 |
| -Due to our workload, it may take several weeks before an approved pull request is merged, so be patient - we will get to it! |
| 39 | +- [how to set up a development environment](https://github.com/otwcode/otwarchive/wiki) |
| 40 | +- [code conventions](https://github.com/otwcode/otwarchive/wiki/Commit-policy) |
34 | 41 |
|
35 |
| -### Testing and fixing bugs |
| 42 | +Please follow the checklist on [our template](https://github.com/otwcode/otwarchive/blob/master/.github/PULL_REQUEST_TEMPLATE.md) when submitting pull requests. |
36 | 43 |
|
37 |
| -Once your pull request is merged, it will be deployed to our internal Staging server and our manual QA team will check it. |
38 |
| -We may ask you to make further changes and submit a new pull request if we find any problems that will affect our users' |
39 |
| -ability to benefit from your changes. |
| 44 | +Please be patient with us! Due to our workload, it may take some time before we |
| 45 | +can review and eventually merge your pull request. |
40 | 46 |
|
41 |
| -### Release |
| 47 | +Once your pull request is merged, it will be deployed to our internal testing site |
| 48 | +and our QA team will check that everything is working as intended. If not, we may |
| 49 | +set the issue to ["Broken on Test"](https://github.com/otwcode/otwarchive/wiki/Issue-Tracking-with-Jira) |
| 50 | +and ask you to make further changes in new pull requests. |
| 51 | + |
| 52 | +If all is well, your contribution will be deployed to the [Archive of Our Own](https://archiveofourown.org) |
| 53 | +and you will be credited in the [release notes](https://archiveofourown.org/admin_posts?tag=1)! |
42 | 54 |
|
43 |
| -Once we have checked that all is well, your contribution will be deployed to [Archive of Our Own](https://archiveofourown.org) and you will be credited |
44 |
| -in the [AO3 Release Notes](https://archiveofourown.org/admin_posts?tag=1)! Make sure you tell us your preferred name and pronoun |
45 |
| -in the pull request. |
46 | 55 |
|
47 | 56 | ## Volunteering for the OTW
|
48 | 57 |
|
49 |
| -If you would like to donate more of your time and expertise in a multi-national, inclusive, fandom-oriented development team, you might |
50 |
| -enjoy becoming an official OTW volunteer. |
| 58 | +If you would like to donate more of your time and expertise in a multi-national, |
| 59 | +inclusive, fandom-oriented team, you might enjoy [becoming an official OTW volunteer](http://transformativeworks.org/how-you-can-help/volunteer). |
51 | 60 |
|
52 |
| -[Read more about volunteering with the OTW](http://transformativeworks.org/how-you-can-help/volunteer). |
53 | 61 |
|
54 | 62 | ## Questions?
|
55 | 63 |
|
56 | 64 | [Drop us an email](mailto:otw-coders@transformativeworks.org) if you have any questions.
|
57 |
| - |
|
0 commit comments