We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
This repository contains a CONTRIBUTING.md file that is automatically used by GitHub for all repositories in the organisation.
CONTRIBUTING.md
This is great as it provides consistency, but it also means is not possible to include repository specific documentation.
I would like to propose adding a conventional path where to add a developer doc to each repo, so can be mentioned from the contributing file.
In the wild I've seen used HACKING.md and DEVELOPMENT.md, we could also use docs/developer.md.
HACKING.md
DEVELOPMENT.md
docs/developer.md
Thoughts? (If this is accepted I'll work in updating the contributing file and adding the relevant file to each repo)
The text was updated successfully, but these errors were encountered:
No branches or pull requests
This repository contains a
CONTRIBUTING.md
file that is automatically used by GitHub for all repositories in the organisation.This is great as it provides consistency, but it also means is not possible to include repository specific documentation.
I would like to propose adding a conventional path where to add a developer doc to each repo, so can be mentioned from the contributing file.
In the wild I've seen used
HACKING.md
andDEVELOPMENT.md
, we could also usedocs/developer.md
.Thoughts? (If this is accepted I'll work in updating the contributing file and adding the relevant file to each repo)
The text was updated successfully, but these errors were encountered: