Skip to content

Conversation

@jsjoeio
Copy link
Contributor

@jsjoeio jsjoeio commented Feb 3, 2021

This PR renames the /doc directory to /docs

Why?

In order for GitHub to automatically recognize our CONTRIBUTING.md file, it must be in one of the following places:

  • the root of the repository
  • the .github folder
  • the docs folder

(Source: About default community health files)

As you can see on our Community page, GitHub doesn't recognize that we have a CONTRIBUTING.md file.

image

I'd like to change that so we're following GitHub's guidelines for healthy contributions.

@jsjoeio jsjoeio self-assigned this Feb 3, 2021
@jsjoeio jsjoeio requested a review from nhooyr February 3, 2021 16:43
@jsjoeio jsjoeio changed the title refactor: rename doc to docs refactor(docs): rename doc to docs Feb 3, 2021
Copy link

@oxy oxy 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 to me! Not sure about the .gitignore change.

Copy link

@oxy oxy 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!

@jsjoeio jsjoeio merged commit 4bace1a into master Feb 4, 2021
@jsjoeio jsjoeio deleted the rename-docs-dir branch February 4, 2021 17:17
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.

2 participants