Skip to content

Team Workflow Guidelines

Jump to bottom
JavaBoii edited this page May 7, 2024 · 1 revision

To keep our project organized and make sure everyone's on the same page, here are the guidelines we should all follow. This will make things smoother for everyone, especially as new members join.

1. Creating Issues

Before you dive into coding, start with a GitHub Issue. This is where you'll outline what you're planning to work on.

  • Title and Description: Make sure the title clearly states what the issue is about. Use the description for extra details.
  • Labels: Tag your issue with labels like enhancement or bug to categorize it properly.
  • Issue Number: You'll get an issue number when you create it. Remember this number because you'll need it for your branches and commits.

Example:

  • Title: "Adding new safeguards and routing norms"
  • Example: Issue #43

2. Branching Strategy

Branches help us keep track of different features and fixes without stepping on each other's toes.

  • Branch Naming Convention: Stick to this format:

[type]/[issue number]-[topic]-[your username abbreviation]

It helps everyone quickly see what’s what.

Example: feature/#43-adding-new-safeguards-JaBo

  • Where to Branch From: Always branch off the main branch unless you're adding to something that’s already being worked on in another branch. This keeps our branch tree neat.

3. Committing Changes

Keep your commits clean and relevant to the issue you're working on.

  • Commit Messages: Start your commit message with the issue number. It makes it easier to track changes back to their source.

    Example Commit: git commit -m "#43 - Test changes that will be reverted"

4. Using Pull Requests

Pull Requests (PRs) are how we review and merge changes.

  • Draft and Ready for Review: If your PR isn't ready for a final look, mark it as a draft. Change it to ready for review when it’s all set.
  • Link Back to Your Issue: After creating your PR, don't forget to link it back to the original issue to keep everything connected.

5. Maintaining and Reviewing Code

We all need to do our part to keep our codebase clean and up-to-date.

  • Stay Updated: Regularly sync your branch with the main branch to avoid conflicts.
  • Code Reviews: Participate in code reviews to ensure quality and share insights.

6. Best Practices

  • Keep It Focused: Each branch should only tackle one main issue to avoid confusion.
  • Keep It Clean: Combine small related commits into a single commit where possible for a clearer history.

Why These Guidelines?

Following these steps helps:

  • Keep our development process transparent and traceable.
  • Make it easier to manage our project as it grows.
  • Help everyone, from current team members to future contributors, navigate and contribute effectively.
Clone this wiki locally