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

Meta: CONTRIBUTING.md: Some changes to make the doc more beginner-friendly #2431

Merged
merged 1 commit into from
Jun 15, 2021

Conversation

tomayac
Copy link
Member

@tomayac tomayac commented Jun 10, 2021

Editorial changes

  • Differentiate "Issue" (uppercase, as in the GitHub concept) from "issue" (lowercase, the problem). Same for "Pull Request".
  • Link the mailing list.
  • Minor word changes.

Layout and markup

  • Use code font for file names and branch names (Are you considering switching from master to main?).
  • Add new line after headings.

Copy link
Member

@ljharb ljharb left a comment

Choose a reason for hiding this comment

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

I’m not sure capitalizing “issue” makes much sense; this is GitHub, so I’d think a non-GitHub-issue “issue” occurrence should use a synonym instead of trying to differentiate it from GitHub issues

CONTRIBUTING.md Outdated Show resolved Hide resolved
@ljharb ljharb added the meta label Jun 10, 2021
@tomayac tomayac requested a review from ljharb June 11, 2021 11:28
Copy link
Member

@ljharb ljharb left a comment

Choose a reason for hiding this comment

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

LGTM

@ljharb ljharb requested a review from a team June 11, 2021 14:02
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
Copy link
Contributor

@syg syg left a comment

Choose a reason for hiding this comment

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

lgtm


To track what's going on with a particular proposal, you can look in issues and commits in the individual proposal repository, read presentation slides which are linked from the TC39 agenda, read the notes which came from the subsequent meetings. You can also reach out via IRC, es-discuss, or direct communication with a proposal champion, if the other resources are unclear.
To track what's going on with a particular proposal, you can look in issues and commits in the individual proposal repository, read presentation slides which are linked from the TC39 agenda, and read the notes which came from the subsequent meetings. You can also reach out via IRC, the [discussion group](https://es.discourse.group/), or direct communication with a proposal champion, if the other resources are unclear.
Copy link
Contributor

Choose a reason for hiding this comment

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

The IRC bit might be worth updating with our migration to Matrix. Can be done in separate PR and doesn't need to block this PR.

@tomayac
Copy link
Member Author

tomayac commented Jun 14, 2021

Looks like we have 2 LGTMs then, but @ljharb's wasn't properly registered since it's a comment.

@ljharb
Copy link
Member

ljharb commented Jun 14, 2021

@tomayac that was intentional, as I’m not an editor. It will be landed when it gets sufficient reviews.

@michaelficarra michaelficarra added the ready to merge Editors believe this PR needs no further reviews, and is ready to land. label Jun 14, 2021
ljharb pushed a commit to tomayac/ecma262 that referenced this pull request Jun 15, 2021
…endly (tc39#2431)

 - Add new line after headings
 - Link the discourse
 - Minor word changes
@ljharb ljharb changed the title Some changes to make the doc more beginner-friendly Meta: CONTRIBUTING.md: Some changes to make the doc more beginner-friendly Jun 15, 2021
ljharb pushed a commit to tomayac/ecma262 that referenced this pull request Jun 15, 2021
…endly (tc39#2431)

 - Add new line after headings
 - Link the discourse
 - Minor word changes
ljharb pushed a commit to tomayac/ecma262 that referenced this pull request Jun 15, 2021
…endly (tc39#2431)

 - Add new line after headings
 - Link the discourse
 - Minor word changes
…endly (tc39#2431)

 - Add new line after headings
 - Link the discourse
 - Minor word changes
@ljharb ljharb merged commit 61cc329 into tc39:master Jun 15, 2021
mathiasbynens pushed a commit to mathiasbynens/ecma262 that referenced this pull request Oct 18, 2021
…endly (tc39#2431)

 - Add new line after headings
 - Link the discourse
 - Minor word changes
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
meta ready to merge Editors believe this PR needs no further reviews, and is ready to land.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants