Skip to content

Commit

Permalink
Docs: Clarify workflow for contributions and Jira (#5010)
Browse files Browse the repository at this point in the history
* Docs: Clarify workflow for contributions and Jira

* Docs: Assigning issue info in step 1

* Docs: Add paragraph
  • Loading branch information
Bilka2 authored Jan 22, 2025
1 parent 092aa07 commit 1e5935e
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 19 deletions.
29 changes: 10 additions & 19 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Reporting bugs

We maintain a [Jira issue tracker](https://otwarchive.atlassian.net) for developers,
We maintain a [Jira issue tracker](https://otwarchive.atlassian.net/projects/AO3/issues) for developers,
and a [list of Known Issues](https://archiveofourown.org/known_issues) for
[Archive of Our Own](https://archiveofourown.org) users, neither of which are
publicly editable.
Expand Down Expand Up @@ -35,30 +35,21 @@ with the exception of spelling corrections and documentation improvements
(e.g. any Markdown files). We also do not accept code generated by AI tools; for more information,
please refer to [our commit policy](https://github.com/otwcode/otwarchive/wiki/Commit-Policy#scary-legal-stuff).

If you'd like the ability to comment on, assign, and transition issues,
you're welcome to create a Jira account! (It makes things a bit easier for us
on the organizational side if the Full Name on your Jira account either closely
matches the name you'd like us to credit in the release notes or includes it in
parentheses, e.g. "Nickname (CREDIT NAME).") We'll give you permissions when
you create your first pull request.

Please check out our development wiki for more information on:

- [how to set up a development environment](https://github.com/otwcode/otwarchive/wiki)
- [code conventions](https://github.com/otwcode/otwarchive/wiki/Commit-policy)

Please follow the checklist on [our template](https://github.com/otwcode/otwarchive/blob/master/.github/PULL_REQUEST_TEMPLATE.md) when submitting pull requests.

Please be patient with us! Due to our workload, it may take some time before we
can review and eventually merge your pull request.

Once your pull request is merged, it will be deployed to our internal testing site
and our QA team will check that everything is working as intended. If not, we may
set the issue to ["Broken on Test"](https://github.com/otwcode/otwarchive/wiki/Issue-Tracking-with-Jira)
and ask you to make further changes in new pull requests.
### Workflow

If all is well, your contribution will be deployed to the [Archive of Our Own](https://archiveofourown.org)
and you will be credited in the [release notes](https://archiveofourown.org/admin_posts?tag=1)!
1. If you're a new contributor, find a task on the [issues reserved for first timers](https://otwarchive.atlassian.net/issues/?filter=13119). Otherwise, or if you're up for a challenge, pick a task from the general [open and unassigned issues](https://otwarchive.atlassian.net/issues/?filter=10800). (If you a new contributor, don't worry about claiming the issue for now. If you make a Jira account, you'll get permissions for claiming issues in step 5.)
2. Write code to address the issue.
3. Optional: Create a Jira account if you'd like the ability to comment on, assign, and transition issues. Please make sure the Full Name on your Jira account either closely matches the name you'd like us to credit in the release notes or includes it in parentheses, e.g. "Nickname (CREDIT NAME)."
4. Submit the code with a pull request following the checklist on [our template](https://github.com/otwcode/otwarchive/blob/master/.github/PULL_REQUEST_TEMPLATE.md).
5. Once you've submitted a pull request, we'll review your code and give you permissions on Jira. Please be patient with us! Due to our workload, it may take some time before we can review and eventually merge your pull request.
6. Once your pull request is merged, we will deploy it to our internal testing site and our QA team will check that everything is working as intended.
7. If something is not working as intended, we may set the issue to ["Broken on Test"](https://github.com/otwcode/otwarchive/wiki/Issue-Tracking-with-Jira) and ask you to make further changes in new pull requests.
8. If all is well, your contribution will be deployed to the [Archive of Our Own](https://archiveofourown.org) and you will be credited in the [release notes](https://archiveofourown.org/admin_posts?tag=1)!


## Volunteering for the OTW
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ We welcome pull requests for bugs described in our issue tracker. Please see our

We do not have a public chat, but you are welcome to contact us at otw-coders@transformativeworks.org if you have any questions.

We grant your Jira account permissions for commenting on, assigning, and transitioning issues [after you create your first pull request](https://github.com/otwcode/otwarchive/blob/master/CONTRIBUTING.md#workflow).

API
----------
There is currently no API for the OTW-Archive software. While it is something we're considering for the future, we ask that contributors instead focus on issues already in our [Jira issue tracker](https://otwarchive.atlassian.net/).
Expand Down

0 comments on commit 1e5935e

Please sign in to comment.