-
Notifications
You must be signed in to change notification settings - Fork 0
feat: Add GitHub governance files #6
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
Conversation
| cd template_python | ||
|
|
||
| # Create a virtual environment | ||
| uv venv |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would prefer to add uv in a separate PR and to try to remove pip when doing it, WDYT?
I have the feeling that adding uv but continuing to rely on pip isn't really the proper way to use uv even if it's of course possible.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also I think the README.md file is still relying on pyenv right?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes the README is still relying on pyenv, that is because I did not change it yet. I was thinking that we can change the README later.
And for the uv vs pip question, I believe it is a good idea to keep pip, because, IMO, uv is not as stable as pip and not everyone uses it, so I would prefer to keep pip as a backup installation option.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For this file I suppose it isn't an issue to use uv to create the virtual environment...
|
|
||
| --- | ||
|
|
||
| ## Maintainer Model |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's a bit unclear if the governance files are intended for the template (i.e. for the projects done from the template) or the template repo itself.
I think it's more for the projects based on this template but if it's for the template repo itself it's a bit relevant because for the moment we can't have maintainers (I think we need an organization account for that and if we can have one freely I will try to do so).
In any case I think we should clarify it somewhere.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So basically this file specifically GOVERNANCE.md is primarily for large organisations and large projects. It is not meant for this particular template project, but it is more for the people who would use this template to start a big project perhaps.
It is more or less a generic file, and does not change a lot, so I can also remove it if you want. People can add it later if they want?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it can be good to have this file but we should find a way to differentiate more clearly between the documentation files used for the projects created with the template and the template repo itself...
We can surely just mention it in the main README, what do you think?
I don't see a better way to specify it and it would be enough in my opinion.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done. I have added some descriptions inside the README for the each individual project files. This will help users to isolate the files they need for the project and remove the ones that are not required.
L111 onwards in the README is the newly added section.
There was a problem hiding this 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, thanks!
Added Governance & Contribution Files
CONTRIBUTING.md– Explains how to contribute code, report issues, and propose features.CODE_OF_CONDUCT.md– Defines expected behavior for all contributors.SECURITY.md– Explains how to responsibly report security vulnerabilities.CHANGELOG.md– Maintains a history of notable changes per version following Keep a Changelog.SUPPORT.md– Provides guidance on where and how to get help with the project.GOVERNANCE.md– Describes project decision-making, roles, and maintainer authority.Updated pre-commit config