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

[Conventions] Rename or softlink to CONTRIBUTING.md? #123

Open
kevinmatthes opened this issue Oct 30, 2021 · 1 comment
Open

[Conventions] Rename or softlink to CONTRIBUTING.md? #123

kevinmatthes opened this issue Oct 30, 2021 · 1 comment
Labels
documentation Topics concerning the documentation. enhancement question
Milestone

Comments

@kevinmatthes
Copy link
Contributor

As the CONVENTIONS.md was enriched with new conventions, recently, due to the ongoing discussion in #120, it becomes more and more a contribution guideline for developers.

Since GitHub defines in its Community Standards that projects should provide exactly such a guideline named CONTRIBUTING.md (see Insights > Community for the full checklist), I would like to suggest a renaming of the file or at least creating a matching softlink to it. Thereby, this community standard would be fulfilled and the role of CONVENTIONS.md would then be honoured as such since, due to the Community Standards, one expects -- more or less -- to find the conventions in a file named CONTRIBUTING.md.

Softlinking or renaming the file would have the further benefit that the conventions are listed on the project's "Welcome Page" since the system recognises it as contribution guideline then. This is also an aspect of quality of a project and, hence, worth to discuss it.

@kevinmatthes kevinmatthes added this to the 3.5.3 milestone Oct 30, 2021
@kevinmatthes kevinmatthes added documentation Topics concerning the documentation. welcome page Topics concerning this project's Start-Up Page. labels Oct 30, 2021
@kevinmatthes
Copy link
Contributor Author

I tested the proposed change in one of my repositories and noticed that the CONTRIBUTING.md will not be shown on the project's "Welcome Page". This behaviour is complementary to GitLab due to which I expected this feature, I am sorry.

Anyway, the file name triggered the completion of one of GitHub's Community Standards which might be still interpreted as one possible measure of quality. Hence, is it worth softlinking or renaming CONVENTIONS.md as suggested?

@kevinmatthes kevinmatthes removed the welcome page Topics concerning this project's Start-Up Page. label Nov 2, 2021
@kevinmatthes kevinmatthes modified the milestones: 3.5.3, 4.0.0 Nov 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Topics concerning the documentation. enhancement question
Projects
None yet
Development

No branches or pull requests

1 participant