Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
151 lines (111 loc) · 4.94 KB

CONTRIBUTING.md

File metadata and controls

151 lines (111 loc) · 4.94 KB

Contributing

Table of Contents

  1. Naming conventions
  2. Conventional commits
  3. Initial setup
  4. How'd you start a new feature, bug fix, etc.?
  5. What about staging?
  6. And what about releases?

Naming conventions

Some things you should know before cloning the repository and making changes:

  • main is for production code only.
  • staging is the pre-release branch tested before merging into production.
  • develop is for development, anything goes. Pull requests should be made against this branch.
graph TD
    A[Naming]
    A1[main: Production code only]
    A2[staging: Step before merging into production]
    A3[develop: Development, anything goes]

    A --> A1
    A --> A2
    A --> A3
Loading

Conventional commits

We follow and enforce the usage of conventional commits for commit messages and pull requests titles.

PR titles are validated with the help of Github actions. More info here.

Commit messages are validated using a Husky commit-msg hook and commitlint. More info here.

Initial setup

  1. Ensure pnpm is installed (https://pnpm.io/)
  2. Fork the repository, then pull it down to your disk:
# Clone the repository
git clone git@github.com:YOUR_USERNAME/dAppBooster.git

# Change the directory
cd dAppBooster

# Checkout the development branch
git checkout develop

# Set the base repository as upstream (makes it easier to pull updates to your fork)
git remote add upstream git@github.com:BootNodeDev/dAppBooster.git

# Create a local .env file
cp .env.example .env.local

# Install the dependencies
pnpm i

How'd you start a new feature, bug fix, etc.?

  1. Find some issue you're interested in, a bug you want to fix, or a new feature you want to implement (make sure that no one else is already working on it!).
# Update your local copy of the develop branch with the latest code changes
git checkout develop
git pull -f upstream/develop

# Run pnpm i to get any dependency updates
pnpm i

# Create a new branch from develop. Give it a meaningful name (`feat/new-feature`, `fix/bug-fix`, `feature/#192`, etc.)
git checkout -b fix/something

# Work on the branch, commit your changes, push them... you know the drill.
# Finally, push the branch.
git push -u origin fix/something
  1. Submit a pull request to the upstream dAppBooster repository.
  2. Choose a descriptive title following the conventional commits guidelines and write a detailed description of the changes you made using the PR template.
  3. Wait for a maintainer to review your PR, make changes if asked, and get it merged.
graph LR
    B[New feature or bug fix]
    B1[Create new branch from develop]
    B2[Name branch descriptively]
    B3[Work on the branch]
    B4[Create pull request]
    B5[Pull request approved]
    B6[Merge branch into develop]

    B --> B1
    B1 --> B2
    B2 --> B3
    B3 --> B4
    B4 --> B5
    B5 --> B6
Loading

What about staging?

Once we reach a point where we feel like a new release is worth creating, we'll submit a pull request asking to merge develop into staging. This is the branch where things should be tested and fixed before merging into main. Consider it a pre-production environment.

We'll test staging thoroughly, fix all the (relevant) bugs and once everything is ready we will:

  1. Merge staging's fixes into develop so the development branch is up-to-date.
  2. Submit a pull request asking to merge staging into main.

And what about releases?

  1. First, make sure the latest changes from staging are merged into main
  2. Commit a version bump into the package.json file following Semantic Versioning's guidelines: https://semver.org/
  3. Then tag main using the version set in the previous step.
  4. Push the changes to main.
  5. Create a new release using that tag.

That's it, everybody can see now that a new version is ready to use and if something's wrong they can go back to a previous version temporarily.

graph TD
    C[Staging Process]
    C1[Merge develop into staging]
    C2[Test and fix bugs in staging]
    C3[Merge staging into develop]
    C4[Merge staging into main]

    D[Releasing a New Version]
    D0[Commit a version bump to package.json]
    D1[Tag main following Semantic Versioning]
    D2[Create a new release using the tag]
    D3[New version is available]

    C --> C1
    C1 --> C2
    C2 --> C3
    C2 --> C4

    D --> D0
    D0 --> D1
    D1 --> D2
    D2 --> D3

    C4 --> D
Loading