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

Standardise developer doc location in repos #6

Open
endorama opened this issue Feb 16, 2022 · 0 comments
Open

Standardise developer doc location in repos #6

endorama opened this issue Feb 16, 2022 · 0 comments
Labels
enhancement New feature or request

Comments

@endorama
Copy link

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 and DEVELOPMENT.md, we could also use docs/developer.md.

Thoughts? (If this is accepted I'll work in updating the contributing file and adding the relevant file to each repo)

@endorama endorama added the enhancement New feature or request label Feb 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant