Skip to content

Commit 2774866

Browse files
authoredMay 13, 2020
Update contributing documentation (otwcode#3830)
* Update contributing documentation - Add a reminder in the pull request checklist to keep <= 5 pull requests open at the same time. - Remove unused issue template. - Restructure CONTRIBUTING.md. - Add SECURITY.md. [skip ci] * Fix wordings, TOS link, and Jira capitalization [skip ci] * Move "Suggesting new features" section [skip ci]
1 parent 17307a8 commit 2774866

5 files changed

+70
-63
lines changed
 

‎.github/ISSUE_TEMPLATE.md

-20
This file was deleted.

‎.github/PULL_REQUEST_TEMPLATE.md

+16-10
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
# Pull Request Checklist
22

3-
* [ ] Have you read [How to write the perfect pull request](https://github.com/blog/1943-how-to-write-the-perfect-pull-request)?
4-
* [ ] Have you read through the [contributor guidelines](https://github.com/otwcode/otwarchive/blob/master/CONTRIBUTING.md)?
5-
* [ ] Have you added tests for any changed functionality?
6-
* [ ] Have you added the [JIRA](https://otwarchive.atlassian.net) issue number as the *first* thing in your pull request title (eg: `AO3-1234 Fix thing`)
7-
* [ ] Have you updated or commented on the JIRA issue with the information below?
3+
* [ ] Have you read ["How to write the perfect pull request"](https://github.blog/2015-01-21-how-to-write-the-perfect-pull-request/)?
4+
* [ ] Have you read the [contributing guidelines](https://github.com/otwcode/otwarchive/blob/master/CONTRIBUTING.md)?
5+
* [ ] Have you added [tests for any changed functionality](https://github.com/otwcode/otwarchive/wiki/Automated-Testing)?
6+
* [ ] Have you added the [Jira](https://otwarchive.atlassian.net) issue number
7+
as the *first* thing in your pull request title (e.g. `AO3-1234 Fix thing`)
8+
* [ ] Do you have fewer than 5 pull requests already open? If not, please wait
9+
until they are reviewed and merged before creating new pull requests.
810

911
## Issue
1012

@@ -16,19 +18,23 @@ What does this PR do?
1618

1719
## Testing Instructions
1820

19-
How can the Archive's QA team verify that this is working as you intended? (If you have access, please copy this into the JIRA ticket for them!)
21+
How can the Archive's QA team verify that this is working as you intended?
22+
23+
(If you have a Jira account with access, please update or comment on the issue
24+
with any new or missing testing instructions.)
2025

2126
## References
2227

23-
Are there any other relevant issues / PRs / mailing lists discussions related to this?
28+
Are there other relevant issues/pull requests/mailing list discussions?
2429

2530
## Credit
2631

2732
*What name do you want us to use to credit your work in the [Archive of Our Own's Release Notes](https://archiveofourown.org/admin_posts?tag=1)?*
2833

29-
(If you have an account on JIRA, please include the same name in the "Full name" field on your JIRA profile,
30-
so we can find you and assign you the issues you're working on.)
34+
(If you have a Jira account, please include the same name in the "Full name"
35+
field on your Jira profile, so we can assign you the issues you're working on.)
3136

3237
*What pronouns do you prefer (she/her, he/him, zie/hir etc)?*
3338

34-
(If you do not fill this in, we will use your GitHub account name and will use "they" to avoid making assumptions about your gender.)
39+
(If you do not fill in this section, we will use your GitHub account name and
40+
they/them pronouns to avoid making assumptions about your gender.)

‎ACKNOWLEDGMENTS.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Acknowledgments
1313
<p><a href="github.com/otwcode/otwarchive"><img alt="" valign="middle" src="http://media.archiveofourown.org/ao3/logos/GitHub_Logo.png" width="200"/> GitHub</a> for collaborative programming.</p>
1414
<p><a href="http://www.haproxy.org/"><img alt="" valign="middle" src="http://media.archiveofourown.org/ao3/logos/logo-med.png" width="200"/> HAProxy</a> for load balancing.</p>
1515
<p><a href="https://houndci.com/"><img alt="" valign="middle" src="http://media.archiveofourown.org/ao3/logos/Hound-Dribbble.png" width="200"/> Hound</a> for style guidance.</p>
16-
<p><a href="https://otwarchive.atlassian.net/"><img alt="" valign="middle" src="http://media.archiveofourown.org/ao3/logos/jira_rgb_blue.svg" width="200"/> JIRA</a> for our issue tracking.</p>
16+
<p><a href="https://otwarchive.atlassian.net/"><img alt="" valign="middle" src="http://media.archiveofourown.org/ao3/logos/jira_rgb_blue.svg" width="200"/> Jira</a> for our issue tracking.</p>
1717
<p><a href="https://nginx.org/en/"><img alt="" valign="middle" src="http://media.archiveofourown.org/ao3/logos/Nginx_logo.svg" width="200"/> NGINX</a> for our front end.</p>
1818
<p><a href="https://memcached.org/"><img alt="" valign="middle" src="http://media.archiveofourown.org/ao3/logos/Memcached.png" width="200"/> Memcached</a> for caching.</p>
1919
<p><a href="https://mariadb.com/products/mariadb-maxscale"><img alt="" valign="middle" src="http://media.archiveofourown.org/ao3/logos/maxscale.png" width="200"/> MaxScale</a> for MySQL load balancing.</p>

‎CONTRIBUTING.md

+39-32
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,64 @@
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).
212

3-
## Contributing code
413

5-
### Report a bug
14+
## Reporting security issues
615

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

11-
### Pick an issue to work on
1218

13-
You will find our [list of approved issues on JIRA](https://otwarchive.atlassian.net/projects/AO3/issues).
19+
## Updating documentation
1420

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!
1724

18-
### Resolve the issue
1925

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
2227

23-
### Submit your pull request
28+
Please [contact the AO3 Support team](https://archiveofourown.org/support).
2429

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

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

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:
3238

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

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

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

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)!
4254

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

4756
## Volunteering for the OTW
4857

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

52-
[Read more about volunteering with the OTW](http://transformativeworks.org/how-you-can-help/volunteer).
5361

5462
## Questions?
5563

5664
[Drop us an email](mailto:otw-coders@transformativeworks.org) if you have any questions.
57-

‎SECURITY.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Reporting a security issue
2+
3+
Please email us directly at [otw-coders@transformativeworks.org](mailto:otw-coders@transformativeworks.org)
4+
with details and reproduction steps. We will get back to you as soon as possible,
5+
and we may ask for additional information or guidance.
6+
7+
Please avoid testing for security issues on the Archive of Our Own itself,
8+
as you risk disrupting other users and violating the [Terms of Service](https://archiveofourown.org/tos#IV.C.).
9+
10+
Please give us a reasonable amount of time to address the issue before any
11+
disclosure to the public or a third-party.
12+
13+
We thank you for your effort and responsible disclosure! We will make sure you
14+
receive due credit on [our public release notes](https://archiveofourown.org/admin_posts?tag=1).

0 commit comments

Comments
 (0)
Please sign in to comment.