Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[core] Add RFC GH issue template #33871

Merged
merged 10 commits into from Sep 9, 2022
Merged

[core] Add RFC GH issue template #33871

merged 10 commits into from Sep 9, 2022

Conversation

bytasv
Copy link
Contributor

@bytasv bytasv commented Aug 9, 2022

@mui-bot
Copy link

mui-bot commented Aug 9, 2022

No bundle size changes

Generated by 🚫 dangerJS against 4b1e9a7

@bytasv bytasv self-assigned this Aug 9, 2022
@bytasv bytasv added the docs Improvements or additions to the documentation label Aug 9, 2022
@bytasv bytasv requested a review from a team August 10, 2022 09:51
Copy link
Member

@mnajdova mnajdova left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding this @bytasv

@michaldudak @siriwatknp please have a look and let us know if you would change something?

@michaldudak
Copy link
Member

👍 looks good. I'm not sure about the requirements section, though - what would I enter here?

@bytasv
Copy link
Contributor Author

bytasv commented Aug 11, 2022

👍 looks good. I'm not sure about the requirements section, though - what would I enter here?

@michaldudak let's assume we wanna create an RFC - "Alternative CI runner" - in the requirements we may list all the things we currently support, i.e.:

  • supports YML configuration
  • reports status back to github
  • runs at least at the same speed or faster than current choice
    and so on...

I guess there might also be cases when we might not know all the requirements right at the beginning so we could modify the list as we go

@oliviertassinari
Copy link
Member

oliviertassinari commented Aug 11, 2022

@oliviertassinari oliviertassinari added core Infrastructure work going on behind the scenes and removed docs Improvements or additions to the documentation labels Aug 11, 2022
@oliviertassinari oliviertassinari changed the title [docs] Add RFC GH issue template [core] Add RFC GH issue template Aug 11, 2022
@bytasv
Copy link
Contributor Author

bytasv commented Aug 11, 2022

Would having a separate repository like https://github.com/reactjs/rfcs so the community can filter out notifications make sense? So far we have assumed that: no.

IMO that might introduce unwanted overhead. It does seem to add value because they do RFCs as markdown files

@mnajdova
Copy link
Member

What are the implications for https://github.com/mui/material-ui/discussions/categories/rfc? I recall we were initially on GitHub issues but then moved to the discussion after #6115 because a single thread makes it hard to have multiple people commenting.

Here are some worries I have regarding this:

  • discoverability/searchability
  • cannot be closed with PR, we need to make sure we manually update it
  • as far as I know discussion can be just deleted not closed (I may be wrong in this assumption)

@oliviertassinari
Copy link
Member

oliviertassinari commented Aug 12, 2022

Alright, then no objections to closing https://github.com/mui/material-ui/discussions/categories/rfc and migrating them as issues if we move forward with this PR.

I wonder though how the community will manage to find new RFCs without the GitHub discussions 😁. The RFC label feels like a must-have. I wish community/community#16645 was a thing, until then, I guess we will have to train them to check this label from time to time.

@mnajdova
Copy link
Member

mnajdova commented Aug 15, 2022

I guess we will have to train them to check this label from time to time.

I would assume this is what most of the community is already doing, but we can double check by asking on Twitter if we have a doubt about this :) cc @samuelsycamore

Also, we can always pin the most important RFCs on top :)

@oliviertassinari oliviertassinari added the RFC Request For Comments label Aug 22, 2022
Copy link
Member

@samuelsycamore samuelsycamore left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! I've just made some suggestions to tighten up the grammar and make it a little more concise.

.github/ISSUE_TEMPLATE/3.rfc.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/3.rfc.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/3.rfc.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/3.rfc.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/3.rfc.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/3.rfc.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/3.rfc.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/3.rfc.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/3.rfc.yml Outdated Show resolved Hide resolved

- type: textarea
attributes:
label: What are the requirements? ❓
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could consider this as part of the problem statement that is above. At least, it's how it's currently done inside https://www.notion.so/mui-org/Shaping-33647d13ed534b838bde5bc8182eba18 (on this one, the idea was to have the template as open ended as possible).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd need to pull in the exact conversation but when we discussed this it was more about listing requirements in it's explicit section. For shaping items it might be less important, but since it's code related your might have certain constraints that you wanna list more often then not.
We could embed this into "problem statement" but I find having it in separate section is easier to find just by scanning 🤔

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

but since it's code related your might have certain constraints that you wanna list more often then not.

I think it's similar for non-code-related topics, e.g. https://www.notion.so/mui-org/Scale-collaborative-inbox-in-Google-Groups-f6f3d7a8a6bd4c24be1fc8b13a8f33f6#7d75b82e0525464c999d5bde5de6a6c2.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is indeed similar to what you show - but how would we formulate this explicitly in the problem statement? Do we expect that everyone will implicitly understand to list the requirements?
Should it simply just be "Requirements" subsection under problem statement?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should it simply just be "Requirements" subsection under problem statement?

It was what I was wondering about, maybe an opportunity to make the RFC template simpler 🤷‍♂️, e.g. https://github.com/reactjs/rfcs/blob/main/0000-template.md has no notions of requirements. But no real preferences.

bytasv and others added 9 commits August 25, 2022 12:16
Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
@bytasv
Copy link
Contributor Author

bytasv commented Aug 25, 2022

@samuelsycamore thanks for great feedback, I've removed duplication and applied your suggestions, it's ready for re-review 🙇

Copy link
Member

@samuelsycamore samuelsycamore left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Text looks great! 👍

@oliviertassinari
Copy link
Member

oliviertassinari commented Aug 28, 2022

What are the implications for https://github.com/mui/material-ui/discussions/categories/rfc?

Are we settling on dropping the use of the GitHub discussions for RFCs?
Or would it work if GitHub discussions are reserved for RFCs we expect a LOT of feedback from the community? So only a handful every year. I feel that for up to 25 comments, a linear history is better, but beyond threads help. In the future, we might even be able to use community/community#2838.

@mnajdova
Copy link
Member

mnajdova commented Sep 8, 2022

Are we settling on dropping the use of the GitHub discussions for RFCs?
Or would it work if GitHub discussions are reserved for RFCs we expect a LOT of feedback from the community?

I would propose we use discussion for sharing ideas we could implement when they are not quite in a form of an RFC. Then we can drop them or create RFC issues for them. For things that we can create RFC directly we should use issues

@bytasv bytasv merged commit adda22c into mui:master Sep 9, 2022
@bytasv bytasv deleted the add-rfc-template branch September 9, 2022 08:57
@oliviertassinari
Copy link
Member

oliviertassinari commented Sep 9, 2022

@mnajdova Ok, I have made a first iteration on how we use RFCs at MUI in https://www.notion.so/mui-org/GitHub-issues-Product-backlog-c1d7072e0c2545b0beb43b115f6030f6#807f7e11ab87450faddf2c43baf14205 based on this.

Feedback welcome.

@bytasv What do think about updating https://github.com/mui/mui-x and https://github.com/mui/mui-toolpad to match line per line of the RFC template in this repository?

So far, we have used http://github.com/mui/material-ui as the source of truth for most things. Why? Because it's where we have the most demanding environment, where we get the most feedback on how things work in practice (in mui-x and mui-toolpad it usually takes a lot more time to get a correct feedback loop because of the much smaller community, the community is we ultimately optimize for). The second value is that it forces us to pick better options, to take into account more perspectives (X and Toolpad's one).

daniel-rabe pushed a commit to daniel-rabe/material-ui that referenced this pull request Nov 29, 2022
* [docs] Add RFC GH issue template

* Update .github/ISSUE_TEMPLATE/3.rfc.yml

Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>

* Update .github/ISSUE_TEMPLATE/3.rfc.yml

Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>

* Update .github/ISSUE_TEMPLATE/3.rfc.yml

Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>

* Update .github/ISSUE_TEMPLATE/3.rfc.yml

Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>

* Update .github/ISSUE_TEMPLATE/3.rfc.yml

Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>

* Update .github/ISSUE_TEMPLATE/3.rfc.yml

Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>

* Update .github/ISSUE_TEMPLATE/3.rfc.yml

Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>

* Update .github/ISSUE_TEMPLATE/3.rfc.yml

Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>

* Remove redundant duplication in RFC

Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core Infrastructure work going on behind the scenes RFC Request For Comments
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants