A team workflow on GitHub
The problem
Set up a small project on GitHub the way a professional team would, and use it for a full feature cycle with a partner (or two of your own accounts).
Requirements
- A repository with a README, a licence and a .gitignore from a template
- Branch protection on main requiring a pull request and passing checks
- A GitHub Actions workflow that runs tests on every push and pull request
- At least three pull requests with review comments, using conventional commit messages
- A tagged release with release notes generated from the commits
Technologies
- Git
- GitHub
- GitHub Actions
- Conventional Commits
Step by step
- Create the repository and protect main.
- Add a test suite and a workflow that runs it.
- Develop features on branches and open pull requests; review each other's work.
- Resolve at least one merge conflict and one failing check.
- Tag a release and publish notes generated from the commit history.
Expected result
A repository whose history, pull requests and releases show a complete, professional workflow.
How it is evaluated
- Nothing reached main without a reviewed pull request and passing checks
- Commit messages follow Conventional Commits
- The release version matches the changes since the last tag
- The README explains how to contribute
Ways to improve it
- Add automatic release notes and version bumps with a release tool
- Run the workflow on several Python versions with a matrix
- Add a CODEOWNERS file and issue templates