Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
30 lines (22 loc) · 1.26 KB

CONTRIBUTING.md

File metadata and controls

30 lines (22 loc) · 1.26 KB

Contribute

Welcome! You are welcomed to contribute and make this project better. You can start modifying the code in the following ways you prefer:

Edit and submit via codesandbox online

  1. Go to Codesandbox: Project Link
  2. Click on Fork button in the upper right corner to launch a development environment.
  3. Wait for the project setup tasks to finish.
  4. Modify the code, then click the console icon, select Run websole with bash and Run pytest in the command list to test your code.
  5. You can also click the VS Code button at the top right corner to open the project in vscode.
  6. Click on the Github icon to push to your personal repository.
  7. Submit a new pull request at Pull Requests.

Edit and submit by setting up a local development environment

  1. Fork this repository.
  2. Clone the forked repository to your local machine using git clone <forked repo>.
  3. Set up a source-based build:
make develop
  1. Modify code, and run the following command to test your code:
make run
  1. Commit to the fork, and submit a new pull request at Pull Requests.