-
-
Notifications
You must be signed in to change notification settings - Fork 5
[WIP] Add project management documentation #69
base: master
Are you sure you want to change the base?
Conversation
I wrote some PM things I learned, and how I'm doing stuff for web extension. These don't need to go in the docs exactly as written. But could help the docs. I don't know what the best way to organise these things or how specific we want to be. Types of open meeting:
Workflow for normal sprint:
Product management lessons:
|
CONTRIBUTING.md
Outdated
Bug: a problem with the code that needs fixing | ||
Feature request: an idea for new features | ||
Feature implementation: details and suggested steps to be completed to add the feature/fix the bug | ||
Bug and feature requests become feature implementations when someone has a brainwave of how to complete the task. Thus a feature implementation issue may contain clear instructions of how to complete task. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't know if a bug necessarily becomes a feature implementation. I think it's fine to leave an issue as "bug". Cuz fixing bugs isn't implementing a feature. So I guess I would just change this by removing the words "Bug and-" from the begnning of this sentence.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreed. Bug fix and feature implementations are two different things. Also this type of info is specific to each repo so I deleted it from the CONTRIBUTING file.
CONTRIBUTING.md
Outdated
review | ||
|
||
[WIP]: indicate you are working on something to avoid duplicated work, request broad review of functionality or API, or seek collaborators (use the help wanted label). | ||
[MRG]: the contribution is complete and should be subjected to a detailed review. If the work is in this state, it should reference the feature request/bug it is fixing |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have never seen this before? I am used to having WIP removed as the indication of status. In the browser extension board there is a lane for review. I would use this as the best place to show the status.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is the workflow for the data team actually, see "Working on a modeling issue" section here. I think we shouldn't generalize the practices of one team to all teams. Also I deleted this info from the CONTRIBUTING file as this is very specific to the people who want to contribute code and this repo should contain information on how to contribute to the project generally. Let me know if the new CONTRIBUTING file covers all cases.
ORG_STRUCTURE.md
Outdated
- Matteo Guzzo | ||
|
||
#### Engineering & DevOps | ||
- River Honer |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Eep um I would much prefer a link to my github than just my name. I want to change the name of my github anyway, away from my legal name
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also @malteserteresa you mentioned in Slack that you put only the people who had their portraits on the website in the docs but River is not on the website. Should we just do a poll in Slack to ask who wants to be in the docs and if we should use our real names or only our Github names?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have deleted the names in the new version of the file. My idea is that we just explain our structure in this file and then in each repo README, people can add themselves if they want and how they want in a "Repository management" section. See this branch as an example.
- Feature implementation: details and suggested steps to be completed to add | ||
the feature/fix the bug | ||
|
||
Bug and feature requests become feature implementations when someone has a |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same comment as above regarding this topic: advise to remove "Bug and". But also this is duplicate info. Which would be hard to manage. Maybe use this file as the source of truth? Not sure,
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I will delete this from the PROJECT_MANAGEMENT file which will contain only general information about the team project boards and our sprints and meetings.
- [WIP]: indicate you are working on something but not finished in order to | ||
avoid duplicated work, premature merges, or use this in the title with the | ||
help wanted label if you want help/collaboration with the issue. | ||
- [MRG]: the contribution is complete and should be subjected to a detailed |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same as above
|
||
Product management FYIs: | ||
|
||
We have meetings mid sprint to talk about issues for the next sprint. This |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Use bullet points *
or -
Someone needs to take ownership of a board. Probably the same person hosting the meeting to make sure tasks are progressing. But without ownership, the board gets outdated and just is cluttered. | ||
|
||
|
||
How Features are decided |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have written about this in my RFC regarding feature spec
I noticed the updates. I have some feedback here that is more general: I gave some feedback to the project management points and how I've been doing it for the web extension "team". But perhaps different groups want to use different patterns? The system I'm using is what I'm going for because it makes the most sense for me when I call meetings. But other people might use a different structure and that can also work really well. I would be hesitant to try to apply the extension development structure to other teams too early? Maybe it's too soon to refine the processes for the whole group down to reproducible parts? The people who take the initiative to call meetings would probably be better off with doing it the way it works for them rather than needing to refer to more documentation. Also, this is a lot of documentation and I dunno if people will read it. I worry it would slow them down. |
Hi @malteserteresa, is it ok to pull your branch and directly insert corrections in there? I would like to restructure the information as it seems it is duplicated in two files and I'd also like to make the content shorter. @river-honer: I would take the comments you have already left into account of course. I just need write permission on this repo :) |
Also, FYI: I'm writing a piece for the blog and I would like to link our holocracy manifesto in there :) |
@lucie-docs You can refer to this RFC as well opt-out-tools/opt-out#110 |
@malteserteresa Chatted with River yesterday and turns out I have write permission on this repo :D So all I really need is your permission to directly modify the structure of your content :) |
@lucie-docs of course :) go forth and document! |
@malteserteresa and @river-honer, I've started shuffling things around and rewriting some files. Please check the following files directly in the branch: README, CONTRIBUTING, ORG_STRUCTURE, ROADMAP. |
@lucie-docs honestly it reads so great now, just a one thing, Anna sadly no longer can be in the team so can you remove her from the contributing.md Also I'm just wondering where we should put the diagram of the OOT architecture and a description of how the repos work together @river-honer do you have any ideas? |
Aw no, are we designer-less again? :( I was thinking of putting the diagram in our backend repository with the explanation of the OOT architecture. Is the diagram actually up-to-date? |
Yeah sadly :( after the Mozilla plug we'll do another "recruitment" drive |
This can be found in the PROJECT_MANAGEMENT.md file
TODO