Skip to content

Latest commit

 

History

History
49 lines (34 loc) · 3.4 KB

CONTRIBUTING.md

File metadata and controls

49 lines (34 loc) · 3.4 KB

Welcome to Ruthenium contributing guide

Thank you for investing your time in contributing to our project!

Please read our Code of Conduct to keep our community approachable and respectable.

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, merging the PR and releasing.

New contributor guide

To get an overview of the project, read the README.

Create a new issue

If you spot a problem with the docs, search if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue form.

Solve an issue

Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. You can also take a look at the open milestones to have an idea of the issues priorities. To follow the progress of issues, let's take a look the projects

As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with changes to solve it.

Prerequisites

  • Go
  • Git

Make changes

  1. Fork the project.
  2. Checkout a new branch (git checkout -b feature/amazing-feature).
  3. Implement your solution following our code conventions
  4. Commit and push your changes (git add .; commit -m 'feat(blockchain): add some amazing feature'; git push origin feature/amazing-feature).
  5. Create a pull request (PR) targeting the main branch.

Review

🛡 Restricted to write access members.

  1. Follow the checklist displayed in the PR.
  2. Submit your review.

Release

The tags and releases are automatically created using semantic-release each time a commit is pushed on the main branch.
The packages are automatically pushed.
The versioning follows the semantic versioning convention.

Conventions

Git

The commit messages on the main branch must follow the Angular commit message format and finish with the PR number (ie fix(ui): message (#1))

Go

We try follow the Golang clean code conventions.