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

Contributing guideline #124

Open
nikstur opened this issue Feb 28, 2023 · 4 comments
Open

Contributing guideline #124

nikstur opened this issue Feb 28, 2023 · 4 comments
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@nikstur
Copy link
Collaborator

nikstur commented Feb 28, 2023

We should create a contributing guideline. This should include our commit conventions (following nixpkgs) and a logging policy (as mentioned in #121). Ideally, we would have a CONTRIBUTING.md file that is linked from the README.

@nikstur nikstur added the documentation Improvements or additions to documentation label Feb 28, 2023
@RaitoBezarius RaitoBezarius added this to the Release 0.4.0 milestone Apr 30, 2023
@AkechiShiro
Copy link

AkechiShiro commented Aug 21, 2023

In the contributing guide, will commits need to have signed-off:<author-name> (like for kernel contributions ?) and perhaps be GPG signed as well, for instance, or there is no need for anything like this yet, to be enforced, just thinking about a security standpoint.

I'm not sure if enforcing this would need to deploy specific bot accounts, I've never enforced this kind of setup for a GH repository.

@AkechiShiro
Copy link

AkechiShiro commented Aug 21, 2023

Maybe we can also scrap some documentation from here :
https://www.conventionalcommits.org/en/v1.0.0/

Or even link it, I'm not sure if it's relevant but from what I see for PR names, it might be.

There would also be the following benefits according to the "specification" of conventional commits :

  • Automatically generating CHANGELOGs.
  • Automatically determining a semantic version bump (based on the types of commits landed).
  • Communicating the nature of changes to teammates, the public, and other stakeholders.
  • Triggering build and publish processes.
  • Making it easier for people to contribute to your projects, by allowing them to explore a more structured commit history.

@RaitoBezarius
Copy link
Member

In the contributing guide, will commits need to have signed-off:<author-name> (like for kernel contributions ?) and perhaps be GPG signed as well, for instance, or there is no need for anything like this yet, to be enforced, just thinking about a security standpoint.

No, I don't think we need to bother ourselves with GPG nonsense, neither with developer certificate of origins.

I'm not sure if enforcing this would need to deploy specific bot accounts, I've never enforced this kind of setup for a GH repository.

This is not relevant.

For the conventional stuff, I feel like you are trying to solve a technical problem.

@AkechiShiro
Copy link

Are these technical problems, something we should actively try to solve in order to have lesser friction for handling new contributions/reviewing and release maintenance ? Or this is not a key focus right now, as other things needs to be polished, first ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants