Contributing

Guide on contributing to Floyd

For contributing to this project you will need to know,

  • Node.js

  • Typescript

Before you start contributing,

  • Search for an issue on the problem you are about to solve.

  • If the issue exists and no one has taken it up, inform that you are taking before you start contributing. If someone has already taken it up, you can either take up another issue, or coordinate a discussion with them to help them complete the issue.

  • If the issue doesn't exist, create one and inform that you have taken it.

To start contributing,

  • Fork this project

  • Clone your fork locally and cd into it

  • Commit your changes and push them

  • Make a pull request.

  • Profit :)

CLI

Coming soon

Last updated