Skip to main content
Before contributing:
  • Make sure you understand the project’s README and contribution guidelines
  • Follow the repository’s branch and commit conventions
  • Run the required checks before opening a pull request
  • Keep changes focused and easy to review
Follow the Clubedge development workflow when making changes to an existing project.
1

Create a feature branch

Keep your work isolated from the main branch.Create a branch using the naming convention defined by the repository. For example:
Common branch types may include:
Always check the repository’s contribution guidelines for the exact branch naming convention before creating your branch.
2

Develop and validate your changes

Make the smallest focused change that solves the problem.While developing, keep the project’s existing architecture, conventions, and patterns in mind.Before committing, run the checks defined by the repository:
Depending on the project, additional checks may include:
Do not wait for CI to discover problems that can be caught locally.

​
Branching

Keep branches focused on a single task or issue. A good branch should be:
  • Small enough to review comfortably
  • Related to one issue or objective
  • Based on the current main branch
  • Easy to remove after the pull request is merged
Avoid mixing unrelated changes into the same branch. For example, a feature branch should not also contain unrelated dependency updates, formatting changes, or refactoring unless they are required for the feature.

​
Commits

Write commits that describe the change being introduced. For example: