Skip to content

Latest commit

 

History

History
73 lines (45 loc) · 2.54 KB

CONTRIBUTING.md

File metadata and controls

73 lines (45 loc) · 2.54 KB
Raw

Contributing

To contribute to the codebase, you will need to fork the repository.

The following steps will get you setup to contribute changes to this repo:

  • Fork the repo and create your branch from next-release.
  • Install depencencies and build.

We use npm to manage installation of dependencies and running various scripts. To get everything installed, make sure you have npm and run npm install from the root of the repository.

Reporting new issues

When opening a new issue, always make sure to fill out the issue template.

  • One issue, one bug: Please report a single bug per issue.
  • Provide reproduction steps: List all the steps necessary to reproduce the issue. The person reading your bug report should be able to follow these steps to reproduce your issue with minimal effort.

Development

Building

Running npm run build from the root directory will run the build command for package.

Branch Organization
  • main Branch: main branch is used version in npm.
  • next-release Branch: next-release branch includes tested and ready for next version of package.
Feature Branches

When starting to work on a new feature development or a bug fix, you must branch out from next-release. The name of the branch should reflect its purpose.

Commit Messages

To standardize our commit messages, we follow the convention described on Conventional Commits.

feat(sdk): additonal event listener for failed step
^--^^----^  ^----------------------------------^
|   |       |
|   |       +-> Summary in present tense.
|   |
|   +-> The place that this change affected.
|
+-------> Type
Pull Requests

When the work on a feature/bug-fix branch is completed, a pull request (PR) should be opened to next-release.

PR Titles

A similar convention with the commit messages applies to PR titles. Avoid giving too much detail on the PR titles, maximum of 4-5 words would be enough to explain the purpose of the PR.

<type>(scope): <pr summary>
PR Descriptions

Include the purpose of the PR, the changes you made, and the expected behavior to PR descriptions. Please fill the PR template, you can feel free to add more sections.

Work on local

You can work on your local project with this package. All you have to do is replace the version part of @perawallet/onramp in the package.json file with "file:path/onramp" like this.

"@perawallet/onramp": "file:../onramp"

After doing this, you can run npm run dev and in this way, you can see the changes you have made to the package simultaneously.