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

Update CONTRIBUTING.md and Branch CI for useful tagging #117

Open
kevinthedang opened this issue Sep 18, 2024 · 2 comments
Open

Update CONTRIBUTING.md and Branch CI for useful tagging #117

kevinthedang opened this issue Sep 18, 2024 · 2 comments
Labels
CI/CD Integration and Deployment documentation Improvements or additions to documentation

Comments

@kevinthedang
Copy link
Owner

Issue

  • Branches can just be whatever they want to be in the repo. Slap a name and it's a branch.
  • Contributing.md has no information on branch naming conventions.

Solution

  • Update CONTRIBUTING.md to include branch naming conventions
  • For example, User Preferences Feature #10 would have a branch called feature/user-preference
    • We can also create some workflows to allow Pull Requests to automatically have the correct initial labels

References

Sample for CI:

on:
  pull_request:
    # Sequence of patterns matched against refs/heads
    branches:
      - main
      - 'feature/**'
      - 'releases/**'
@kevinthedang kevinthedang added documentation Improvements or additions to documentation CI/CD Integration and Deployment labels Sep 18, 2024
@kevinthedang
Copy link
Owner Author

@JT2M0L3Y
Copy link
Collaborator

This is a good idea. I've tried to do this in the past, but it's felt out of place.

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

No branches or pull requests

2 participants