Skip to content

Latest commit

 

History

History
100 lines (67 loc) · 4.01 KB

CONTRIBUTING.md

File metadata and controls

100 lines (67 loc) · 4.01 KB
Raw

Contributing to Ev3 Adapters

Code of Conduct

EV3 has adopted the Contributor Covenant as its Code of Conduct, and we expect project participants to adhere to it.

Please read the full text so that you can understand what actions will and will not be tolerated.

Working on your first Pull Request?

There are a lot of great resources on creating a good pull request. We've included a few below, but don't be shy we appreciate all contributions and are happy to help those who are willing to help us!

Adding a new project?

Awesome! It's pretty straight-forward. We recommend copying an existing project to get started. You'll see that they all follow a similar pattern. You'll need to fill out:

  1. Project Name:
  2. Chain: Choose between 'ETHEREUM', 'SOLANA', 'ALGORAND', 'COSMOS', 'CARDANO', 'POLKADOT', 'POLYGON', 'IOTEX', 'BINANCE', 'KADENA', etc. Use 'NATIVE' for native chains or 'n/a' for projects with no token.
  3. Category: Choose between 'WIRELESS', 'SENSORS', 'ENERGY', 'COMPUTE', 'AI' or 'OTHER'.
  4. Token: ticker (e.g., 'BTC' or 'ETH')
  5. CoingeckoID: Find on CoinGecko project page (in URL).
  6. CmCID: Find on CoinMarketCap project page (in image URL of project icon).
  7. ID: Generate in Step #6 below.

Preparing a Pull Request

Try not to include more than one project/issue in a single PR. It's much easier for us to review multiple small pull requests than one that is large and unwieldy.

  1. Fork the repository.

  2. Clone the fork to your local machine and add upstream remote:

git clone https://github.com/<your username>/adapters.git
cd adapters
git remote add upstream https://github.com/ev3-team/adapters.git
  1. Synchronize your local staging branch with the upstream remote:
git checkout staging
git pull upstream staging
  1. Install dependencies with pnpm:
pnpm i
  1. Create a new branch related to your PR:
git checkout -b project/<project-name>

  1. Copy & rename an existing project folder, then fill out the relevant datapoints.

  2. Generate new uniqueID and paste in into the new project file:

pnpm generate:project-id
  1. Then commit and push to your forked repository:
git push -u origin HEAD

  1. Go to the repository and make a Pull Request.

  2. We will review your Pull Request and either merge it, request changes to it, or close it with an explanation. Please email ninja@ev3.xyz with any questions.

Publishing a new version

In order to see the changes reflected in the frontend you'll have to publish a new package version, we are using changeset and github actions to do this, you can follow the next steps if you want to publish a new version:

  • Make sure you’re in staging branch with latest changes: git checkout staging && git pull
  • Run pnpm changeset and fill in the two fields: 1. What kind of change is this.. and 2. Summary confirm changeset. (this step will generate a .md file in the .changeset folder )
  • Then run pnpm changeset version this command will use the generated .md file to update the package.json with the new version and the update the CHANGELOG.md file with the new version description.
  • Then commit and push this changes to staging.
  • After you have all your changes ready to publish then merge staging into main, this step will trigger the publish ci job.

Contribute from a browser IDE

Make changes and contribute in a single click with an already setup and ready to code developer environment using Gitpod !

Open in Gitpod