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

gh: refactor community files #331

Merged
merged 2 commits into from
Mar 10, 2023
Merged

gh: refactor community files #331

merged 2 commits into from
Mar 10, 2023

Conversation

SauravMaheshkar
Copy link
Contributor

This PR aims to move the CODE_OF_CONDUCT.md and CONTRIBUTING.md file from the root of the directory to the .github/ directory. Github looks for a contribution guideline file in the following order: .github dir > project root > docs dir (source). Moving the file to the .github/ dir leads to a minimal project structure without any functional change.

@michalk8 Request for Review

@michalk8
Copy link
Collaborator

@SauravMaheshkar looking at your fork, there doesn't seem to be Code of Conduct present anymore on the right panel (though it's not present also on your main branch). Looking at this, it doesn't specify whether CoC is also searched for in .github.

@SauravMaheshkar
Copy link
Contributor Author

@SauravMaheshkar looking at your fork, there doesn't seem to be Code of Conduct present anymore on the right panel (though it's not present also on your main branch). Looking at this, it doesn't specify whether CoC is also searched for in .github.

Hey @michalk8 thanks for getting back. I'm not sure if it's visible on forks or not. However if you look at SauravMaheshkar/python-template or datamol-org/datamol you'll find that Code of Conduct is visible on the right pane although the file is placed within the .github/ dir.

Also in the Github Documentation's "Creating a default community health file" page, you'll find CODE_OF_CONDUCT.md in the supported file type and mentions of Github searching for it in the root, .github dir or the docs/ dir.

@michalk8 michalk8 merged commit ba133df into ott-jax:main Mar 10, 2023
@SauravMaheshkar SauravMaheshkar deleted the gh-refactor branch March 10, 2023 14:44
michalk8 pushed a commit that referenced this pull request Jun 27, 2024
* Rename CODE_OF_CONDUCT.md to .github/CODE_OF_CONDUCT.md

* Rename CONTRIBUTING.md to .github/CONTRIBUTING.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants