Skip to content

Latest commit

 

History

History
45 lines (29 loc) · 1.27 KB

CONTRIBUTING.md

File metadata and controls

45 lines (29 loc) · 1.27 KB
Raw

Contributing to Restapify

Hello! 👋

Thanks for contributing on Restapify. Before implementing new features and changes, feel free to submit an issue. We're going to talk here.

🌱 How to submit a pull request?

  1. Fork this repository.
  2. Create a new feature branch. (Eg: feature/add-selector-syntax)
  3. Make your changes.
  4. Make a little check using yarn lint && yarn test
  5. Commit your changes using the gitmoji convention.
  6. Submit your pull request.

🔨 How to start Restapify locally

  1. Clone the project
git clone https://github.com/johannchopin/restapify.git
cd restapify
  1. Install the dependencies and run the initialisation
yarn install && yarn restapify:init
  1. Run the test script

You can easily see your change by running the ./test/run.ts script that serve the mocked API from ./test/api:

yarn test:manual

💻 Use the cli locally

If you make some update on the cli of restapify and want to test the changes, just run the command yarn link at the root of the project.

🎨 Design

All the icons are created by using Figma https://www.figma.com/file/ggaBPd6ix2QvIyCx8QQpWg/icons.