documentation
documentation copied to clipboard
anitab-org
Create a visual representation of our Open Source workflow
Problem
As we evolve as a community, we are evolving our open source workflow. Currently we have been trying to add a QA testing step to how we handle pull requests, and this is not yet visually represented. I think this could clear up confusion from new and current contributors.
In the past, we had this open source workflow: http://systers.io/open-source-workflow
Today we have a specific way of assigning labels to define the status of PRs and issues. We want to have this visually represented.
To help understand some of our workflow currently being followed, check our Open Source teams guide.
Tasks
- [ ] Create a visual representaiton that explains ourcurrent open source wokflow.
@mitchell-frost sure you can :) Do you understand what this is about and where you can find information to build this representation?
@isabelcosta I am actually not sure where to start. Any help shall be appreciated!
@mitchell-frost no problem, I would start by looking at the document I mention in the issue description - Open Source teams guide - so you understand the label system we use.
For example, these are some of the things we'd like to see in the representation: workflow since someone creates an issue until a PR of that issue is merged. We use some labels to manage the PRs current status. For example, after we have 2 minimum code reviews we add the "Status: needs Testing" label. After at least someone reports a tests done to the PR, if no issue arises, we add label "Status: Ready to Merge" so that maintainers know they can merge the PR.
You can also see a past workflow representation in the issue description. Do you understand this is not a coding issue but a documentation one? The result of this may get into our https://anitab-org.github.io website, and general documentation in this repository. This is something to guide our current and future contributors.
Are you on our Zulip? If not i would advise you to join, you may understand some of our workflow discussions there.
👉 https://anitab-org.zulipchat.com/
@isabelcosta thanks! I will start working on it and I understand that it's a documentation issue.
@mitchell-frost Feel free to use GitHub comments or Zulip messages or an office hour of mine to discuss this and ask more questions. I am having an office hour today at 23h (Lisbon timezone) :)
I am working on another issue as well. I will keep you updated about the progress @isabelcosta
@mitchell-frost its better to focus on one issue at a time. Do you mind if I make this available again, until you are available again? This is a high priority issue, because there is a lot of confusion in the community with what we are doing in the community
@isabelcosta she is already working on a issue in anitab-org.github.io open source website (https://github.com/anitab-org/anitab-org.github.io/issues/42). its better to make this issue available again. and i agree we do need to setup the contribution guidelines again for all the repository especially for newcomers and other contributions
@nandini45 thank you for the update, I will make this available again :)
Workflow requirements:
When the PR is in Status: Needs Review - 2 minimum approved code reviews.
When the PR is in Status: Needs Testing: minimum 1 tester has to test locally and report it as a comment on the PR.
Tester says: → success → “Status: Ready to Merge” → failure → “Status: Needs Review”
@isabelcosta @nandini45 Apologies about the confusion. I am new here. I will try not to take up two issues at once.
@mitchell-frost no worries at all! We prefer for contributors to work on one issue at a time so that others can take on other issues. Now you know :) I hope you are enjoying working on the other issue.
@rpattath I talked about this in the Content Open Session today, and @mayburgos agreed to help you with the visual representation, your PR is still going to be part of this work :)
@isabelcosta sounds like a great plan !
@mayburgos let me know if you want me to come up with a visual representation for you to review, or if you are coming up with one I would be more than happy to look at it.
@mayburgos @isabelcosta please release me from this Issue. I think integration test automation is a very pressing issue for qa-team as of now. I would like to focus on that. I am sorry.
@rpattath no need to apologize. We completely understand, and you updated us, that's all we need :)
- Hi, @isabelcosta this is Sonakshi. I am new here and would very much like to contribute to this issue.I hope I can help in resolving it. Can I get started on this? Any help would be appreciated.
Hi @isabelcosta, I’m Judith and I would like to contribute to this. I await your response.
@noobkid2411 are you still interested in working on this? If yes, I'll assign to you if not, no problem, I'll assign to @devifeoma :)
Hi @noobkid2411 https://github.com/noobkid2411, I await your swift response.
On Mon, Feb 8, 2021 at 11:59 PM Isabel Costa [email protected] wrote:
@noobkid2411 https://github.com/noobkid2411 are you still interested in working on this? If yes, I'll assign to you if not, no problem, I'll assign to @devifeoma https://github.com/devifeoma :)
— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/anitab-org/documentation/issues/3#issuecomment-775519828, or unsubscribe https://github.com/notifications/unsubscribe-auth/ADZEQ4K63DZFTLINC2NDUITS6BUEXANCNFSM4NHAJNYQ .
@isabelcosta @devifeoma yeah I'm still interested ,I'd like to start on this issue.
@devifeoma we have another project with a documentation issue, if you'd like to work on it, leave a comment and I will assign it to you :) Issue: https://github.com/anitab-org/open-source-programs-web/issues/71
Hi Isabel, yes I’m interested in working project. Let me know about it.
On Wed, Feb 10, 2021 at 1:11 AM Isabel Costa [email protected] wrote:
@devifeoma https://github.com/devifeoma we have another project with a documentation issue, if you'd like to work on it, leave a comment and I will assign it to you :) Issue: anitab-org/open-source-programs-web#71 https://github.com/anitab-org/open-source-programs-web/issues/71
— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/anitab-org/documentation/issues/3#issuecomment-776332056, or unsubscribe https://github.com/notifications/unsubscribe-auth/ADZEQ4LSIS77FRZYTVZ2A7TS6HFL7ANCNFSM4NHAJNYQ .
Yes, @isabelcosta https://github.com/isabelcosta assign to me.
On Wed, Feb 10, 2021 at 10:30 AM Judith Ifeoma Nwokike < [email protected]> wrote:
Hi Isabel, yes I’m interested in working project. Let me know about it.
On Wed, Feb 10, 2021 at 1:11 AM Isabel Costa [email protected] wrote:
@devifeoma https://github.com/devifeoma we have another project with a documentation issue, if you'd like to work on it, leave a comment and I will assign it to you :) Issue: anitab-org/open-source-programs-web#71 https://github.com/anitab-org/open-source-programs-web/issues/71
— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub < https://github.com/anitab-org/documentation/issues/3#issuecomment-776332056 , or unsubscribe < https://github.com/notifications/unsubscribe-auth/ADZEQ4LSIS77FRZYTVZ2A7TS6HFL7ANCNFSM4NHAJNYQ
.
— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/anitab-org/documentation/issues/3#issuecomment-776571715, or unsubscribe https://github.com/notifications/unsubscribe-auth/ADZEQ4MRKT6AJTVKRNRDK4LS6JG3HANCNFSM4NHAJNYQ .