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

Create unique README across all projects #101

Closed
9 tasks
endriu3314 opened this issue Apr 16, 2022 · 0 comments · Fixed by #102
Closed
9 tasks

Create unique README across all projects #101

endriu3314 opened this issue Apr 16, 2022 · 0 comments · Fixed by #102
Labels
documentation Improvements or additions to documentation

Comments

@endriu3314
Copy link
Member

endriu3314 commented Apr 16, 2022

Linked to it-pebune/ani-research-backend#57

Proposal

Follow a unique style README across all projects, including the same workflow and issue template.

Labels

Modify the current labels to the following:

  • bug #d73a4a: Something is wrong (used for issues)
  • dependencies #0366d6: Issue that warns about dependencies / PR that updates dependencies
  • documentation #bfd4f2: Issue/PR that updates documentation
  • feature #5319e7: PR that adds a feature to the application
  • fix #d93f0b: PR that fixes an existing issue
  • hotfix #b60205: PR that fixes an urgent issues (deploys directly to production)

Still keep:

  • enhancement, help wanted, good first issue, duplicate, wontfix

Branches & Contributing

Branches

Proposing two default branches:

  • main - Staging (ex development)
  • prod - Production (ex master)

Every feature/fix will be merged stashed into main.
Main will be merged with all commits to prod.

Rules

Add the following branch protection rules:
For main:

  • Require a pull request before merging
    • Require approvals - min 1
  • Require status checks to pass before merging
    • Require branches to be up to date before merging
    • When adding tests, require tests to pass
  • Require conversation resolution before merging
  • Require lienar history

For prod:
Same as main but add following:

  • Dismiss stale pull requests approvals when new commits are pushed
  • Include administrators

Tags

Follow a clear workflow when contributing, using the same branch tags:

  • - feature/branch-name - New feature from main
  • - fix/branch-name - New fix from main
  • - hotfix/branch-name - New fix from prod (deployed directly, skips staging)

Workflow

  • Get assigned an issue
  • Create a new branch conform with the Tags
  • Create a PR pointing to either main or prod
  • Review & Publish
@endriu3314 endriu3314 added the documentation Improvements or additions to documentation label Apr 16, 2022
@endriu3314 endriu3314 changed the title Create README files for all repos Create README Apr 16, 2022
@endriu3314 endriu3314 changed the title Create README Create unique README across all projects Apr 16, 2022
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

Successfully merging a pull request may close this issue.

1 participant