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

Best practices: add new ideas and links #49

Merged
merged 2 commits into from
Sep 18, 2018
Merged

Conversation

tripu
Copy link
Member

@tripu tripu commented Sep 18, 2018

“Best practices and recommended tools”:

  • For all users: add new sections “own your code” and “submit atomic PR's”.
  • For repo maintainers: add advice about enforcing code reviews on certain branches, the CODEOWNERS file, and the need to have LICENSE.md in the root directory.
  • Add reference to w3c/nodejs at the bottom.
  • Fix markup.

Also, add a CODEOWNERS file (eating our own dog food), and I have already changed the settings on this repo to start using it.

Copy link
Member

@vivienlacourba vivienlacourba left a comment

Choose a reason for hiding this comment

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

Those additions look good.

@tripu tripu merged commit 27a98ee into master Sep 18, 2018
@tripu tripu deleted the tripu/best-practices branch September 18, 2018 15:50
@plehegar
Copy link
Member

This PR workflow isn't integrated with
https://w3c.github.io/workflow.html
or
https://w3c.github.io/specs.html

So, it's becoming confusing which pages to look. Let's not end up where the /Guide is, ie just a repository of various docs without interlinks.

By integrating, I don't mean that your doc needs to be merged with the existing ones, but the TOC should be clearer how they relate.

@tripu
Copy link
Member Author

tripu commented Sep 23, 2018

Good point, @plehegar. We should try to better direct users to the appropriate page from the TOC, now that the documentation has finer granularity. Also, make sure we don't repeat ourselves, and link between pages when that makes sense. (Am I interpreting your comment right?)

I'll bear that in mind in future PRs.

@plehegar
Copy link
Member

yep, you got my comment right.

tripu added a commit that referenced this pull request Sep 26, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants