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

Repository Management #24

Open
3 of 5 tasks
Tohaker opened this issue Sep 11, 2023 · 4 comments
Open
3 of 5 tasks

Repository Management #24

Tohaker opened this issue Sep 11, 2023 · 4 comments
Labels
developer experience documentation Improvements or additions to documentation security

Comments

@Tohaker
Copy link
Collaborator

Tohaker commented Sep 11, 2023

With multiple developers contributing, we should have some rules in place to ensure the main branch stays clean and tidy. I have some suggestions based on previous experience, very much open to discussion though;

  • Require all Quality jobs to pass in CI before a PR can be merged
  • Require Squash and merge as the only merge option
  • Auto-delete branches after they've been merged
  • Conventional Commits (Optional, works nicely with many automated tools such as Changelog generators)
  • More detail in the CONTRIBUTING.md guidelines - there's plenty of examples in the community for this
@Tohaker Tohaker added documentation Improvements or additions to documentation developer experience security labels Sep 11, 2023
@danstarns
Copy link
Member

I totally agree with all these points.

Till now it's just been myself and so now it needs these listed to make it easier for everyone to contribute.

@danstarns
Copy link
Member

I have added the necessary protection to the main branch and so now PRs require those checks.

Plus squash is now the only allowed option.

@Tohaker
Copy link
Collaborator Author

Tohaker commented Sep 13, 2023

Added a new requirement - auto deleting branches after they've been merged. Helps keep the branches clean

@carbonrobot
Copy link

Since you are already using Github Actions, consider using Changests with its automated Github Action.

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

No branches or pull requests

3 participants