Skip to content

Latest commit

 

History

History
173 lines (133 loc) · 6.13 KB

CONTRIBUTING.md

File metadata and controls

173 lines (133 loc) · 6.13 KB
Raw

Contributing to CipherSwarm

Thank you for your interest in contributing to CipherSwarm! We appreciate your efforts and value your time. This guide will help you understand how to contribute effectively to the project.

Table of Contents

  1. Getting Started
  2. Gitflow Workflow
  3. Conventional Commits
  4. Running Tests
  5. Submitting Contributions

Getting Started

To get started with contributing to CipherSwarm, you'll need to:

  1. Fork the repository from CipherSwarm.
  2. Clone your fork to your local machine: 
    git clone https://github.com/your-username/CipherSwarm.git
  3. Set up the project dependencies: 
    bundle install

Gitflow Workflow

We use the Gitflow workflow to manage our development process. Here’s a brief overview:

  • Main Branches:

    • main: This is the production branch. All releases are made from this branch.
    • develop: This is the main development branch where the latest development changes are merged.

  • Supporting Branches:

    • feature/*: Feature branches are used to develop new features. They branch off from develop and are merged back into develop when complete.
    • release/*: Release branches support the preparation of a new production release. They branch off from develop and are merged into both develop and main.
    • hotfix/*: Hotfix branches are used to patch production releases quickly. They branch off from main and are merged back into both develop and main.

Using Gitflow Tools

To simplify the Gitflow workflow, you can use the git-flow tools. First, ensure you have git-flow installed:

  • macOS: Install via Homebrew

    brew install git-flow

  • Windows: Install via chocolatey

    choco install gitflow-avh

  • Linux: Install via your package manager

    sudo apt-get install git-flow

Creating and Merging Branches with Gitflow Tools

  • Feature Branches:

    • Start a new feature: 
      git flow feature start your-feature-name
    • Finish the feature (this will merge it into develop and delete the feature branch): 
      git flow feature finish your-feature-name

  • Release Branches:

    • Start a new release: 
      git flow release start your-release-name
    • Finish the release (this will merge it into both main and develop, tag the release, and delete the release branch): 
      git flow release finish your-release-name

  • Hotfix Branches:

    • Start a new hotfix: 
      git flow hotfix start your-hotfix-name
    • Finish the hotfix (this will merge it into both main and develop, tag the hotfix, and delete the hotfix branch): 
      git flow hotfix finish your-hotfix-name

Manually Creating and Merging Branches

If you prefer to manage branches manually, you can follow these steps:

  • Feature Branches (feature/*):

    • Rebase: Before merging a feature branch into develop, rebase it to ensure a clean, linear commit history. 
      git checkout feature/your-feature-name
git rebase develop
    • Merge: Once rebased, merge the feature branch into develop using a regular merge to capture all commits. 
      git checkout develop
git merge feature/your-feature-name

  • Release Branches (release/*):

    • Merge: Use a regular merge to integrate changes from the release branch into both develop and main. 
      git checkout main
git merge release/your-release-name
git checkout develop
git merge release/your-release-name

  • Hotfix Branches (hotfix/*):

    • Merge: Use a regular merge to quickly apply the hotfix to both main and develop.

      git checkout main
git merge hotfix/your-hotfix-name
git checkout develop
git merge hotfix/your-hotfix-name

Following these merge strategies ensures that all commits are correctly captured and our commit history remains straightforward.

Conventional Commits

We use the Conventional Commits specification to streamline our commit messages. This ensures clarity in commit history and helps with automated versioning.

Here are the title maps we use for conventional commits, along with their meanings:

  • feat: Features - A new feature for the user.
  • fix: Bug Fixes - A bug fix for the user.
  • perf: Performance Improvements - Changes that improve performance.
  • refactor: Code Refactoring - A code change that neither fixes a bug nor adds a feature.
  • ci: CI Changes - Changes to our CI configuration files and scripts.
  • docs: Documentation - Documentation only changes.
  • style: Style Changes - Changes that do not affect the meaning of the code (white space, formatting, missing semi-colons, etc.).
  • test: Test Changes - Adding missing tests or correcting existing tests.
  • chore: Chores - Other changes that don't modify src or test files.
  • Bump: Dependency Bumps - Updating dependencies.
  • Merge: Merge Commits - Merging branches.
  • Added: Added Features - Adding new features.

Running Tests

All contributions must pass the rspec tests before they can be merged. You can run the tests using the rake command:

  1. Run the tests: 
    rake

Make sure all tests pass before submitting your contribution.

Submitting Contributions

When you are ready to submit your changes, follow these steps:

  1. Push your branch to your forked repository: 
    git push origin feature/your-feature-name
  2. Open a pull request (PR) from your branch to the develop branch of the main repository.

Please provide a clear and detailed description of your changes in the PR and reference any relevant issues or discussions.

Code of Conduct

Please note that we have a Code of Conduct. By participating, you are expected to uphold this code.

Thank you for contributing to CipherSwarm! We look forward to your pull requests.