Docs: Clarify workflow for contributions and Jira #5010
Conversation
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
sarken
reviewed
Jan 5, 2025
| @@ -22,7 +22,8 @@ We welcome pull requests for bugs described in our issue tracker. Please see our | |||
| * [Developer Documentation](https://github.com/otwcode/otwarchive/wiki) | |||
| * [Commit Policy](https://github.com/otwcode/otwarchive/wiki/Commit-policy) | |||
|
|
|||
| We do not have a public chat, but you are welcome to contact us at [email protected] if you have any questions. | |||
| We do not have a public chat, but you are welcome to contact us at [email protected] 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). | |||
There was a problem hiding this comment.
It looks like this is meant to be a different paragraph than the part about the chat, so I think we need a blank line between the two lines.
There was a problem hiding this comment.
It's meant to be a linebreak but not a different paragraph, like this.
Second sentence.
So my question is whether we want that formatting or if a new paragraph would be more standard. I'd be fine with either.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue
None, doc change.
Purpose
Improve the documentation of the code contribution workflow by turning it into an ordered list. This makes the order of the steps more clear, especially in regards to Jira account permissions. Mention the Jira account permissions in the readme, together with the mailing list.
References
Internal discussion from Dec 27 and Dec 30.
Credit
Bilka