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.

Sign up for GitHub

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

Jump to bottom

Add instructions on how to contribute a minor change #281

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Add instructions on how to contribute a minor change #281

wants to merge 4 commits into from

Conversation

dstansby
Copy link
Contributor

This:

  1. Creates a latest copy of the specification again, which can be used to propose changes against.
  2. Adds a new contributing section, explaining that minor changes or clarifications should be opened as a pull request directly to the latest folder. This page should also explain how to open an RFC (and broadly the line between not-an-RFC and RFC change), but that's out of scope for this PR.
  3. Adds a changelog to the bottom of the spec, so we have a tracked and easy to read list of changes to the spec over time.

I'm hoping this makes it clearer and easier to contribute changes to the specification?

Fixes #271, fixes #276

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 29, 2024 •
edited
Loading

Automated Review URLs

@dstansby dstansby mentioned this pull request Nov 29, 2024
Open
@dstansby dstansby changed the title Populate latest folder with copy of spec Add instructions on how to contribute a minor change Nov 29, 2024
@thewtex thewtex requested review from joshmoore and Copilot December 9, 2024 19:39
Copilot
Copilot AI reviewed Dec 9, 2024
View reviewed changes

Choose a reason for hiding this comment

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

Copilot reviewed 44 out of 44 changed files in this pull request and generated no suggestions.
@joshmoore
Copy link
Member

Big 👍 for the additional page. Thanks, @dstansby. Can you take a look at the strategy in #282 to see if you think it could also be (made) new contributor friendly?

@dstansby
Copy link
Contributor Author

I think it's worth rolling this in with #282, adding a contributing section in this PR. It can be copied from this PR to start with, but I think explaining how to work with the proposed layout at #282 will help evaluate it (instead of building some versioning machinery in a documentation free vacuum).

I'll take a look and give some feedback over in #282.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

Copilot Copilot left review comments

@joshmoore joshmoore Awaiting requested review from joshmoore

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Which copy of the SPEC should changes be proposed against? spec diffs can be hard to read
2 participants
@dstansby @joshmoore