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

Update file conventions #72

Closed
wants to merge 1 commit into from
Closed

Conversation

jonathantneal
Copy link
Contributor

In an effort to improve our RFC process, this PR simplifies the current file structure.

  1. Drops the 0000 prefix before proposals, because it was not used meaningfully.
  2. Drops the -rfc suffix from the active directory, because it is redundant.
  3. Introduces the complete directory for RFCs that have been accepted and implemented.
  4. Removes the .placeholder file that instructed itself to be removed when items existed in active.

@tony-sull
Copy link

Nice, big fan of this cleanup!

Drops the 0000 prefix before proposals, because it was not used meaningfully

Was the original idea behind the 0000 to number the RFCs so the files get sorted by acceptance? If so, I could see keeping that naming convention and updating the existing RFCs so they all have a unique prefix #

@matthewp
Copy link
Contributor

lgtm

@natemoo-re
Copy link
Member

Was the original idea behind the 0000 to number the RFCs so the files get sorted by acceptance? If so, I could see keeping that naming convention and updating the existing RFCs so they all have a unique prefix

Yes, I think the point was to keep things organized and have a short-hand way to reference RFCs, like by RFC0215.

However, I’m not opposed to dropping it. It’s not super useful now. At a larger scale I can see the utility, though.

@jasikpark
Copy link
Contributor

I have yet to make an RFC of the new design, but I would argue that if we think having an RFC # will be good in the future, it's better to be consistent, rather than needing to add numbering later... https://github.com/npm/rfcs/blob/main/accepted/0038-workspaces-run-cmds.md seems like a good example where it's useful

I often find referencing issue #'s and pr #'s to be useful when discussing them, so maybe that could be kept?

@jonathantneal
Copy link
Contributor Author

jonathantneal commented Jan 14, 2022

All, how would you feel about this amendment or followup?

  • I write my RFC in pending/my-feature.md and that’s my PR.
  • Upon acceptance, we merge.
  • A GitHub Action moves the file out of pending and into active, with the incremented numeric prefix.

@jonathantneal jonathantneal deleted the jn.update-file-conventions branch January 25, 2022 22:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants