Contributing Guide
⏱ tutorial time: 20 minutes
Last updated
Was this helpful?
⏱ tutorial time: 20 minutes
Last updated
Was this helpful?
This tutorial will help you set up a full Development environment with all components of the isabl
infrastructure.
Clone locally:
Build containers:
Run tests using :
Or run , or individually:
Create a superuser with username and password set to admin
(we will need it later):
Since tests were run inside a container, we need to combine the coverages to see the html report:
Clone locally:
Note: if your changes depend on a particular branch of Isabl API, make sure both Isabl CLI and Isabl API branches are called the same so that the travis configuration can pick that up.
Clone locally:
Install yarn:
Install dependencies:
Start the react development server:
Important! export FRONTEND_URL=localhost:8080
before running docker-compose up
in the api repository, note that the port may vary.
Create a branch for local development and get ready to make changes locally:
Commit your changes and push your branch to GitHub (see the emoji reference):
Create a test in:
Submit a pull request through the GitHub website.
We use emojis to quickly categorize commits and pull requests. These are some common type of changes we use but feel free to ignore the conventions:
emoji
name
type of change
🚀
rocket
new feature
🐛
bug
bug fix
📝
memo
changes to documentation
🎨
art
formatting no code change
🔧
wrench
refactoring production code
✅
white_check_mark
adding/editing test logic
👕
shirt
no production code change
💎
gem
bump to new version
Now you can login in the frontend at (there won't be much to see). An easy way to create objects is to run the tests.
Install with pip, it is strongly recommended to install in a :
Run tests using , make sure you created the admin user:
Or run , or individually:
Simply create a PR in :
Python Projects are formatted with . Is required for api
, cli
and apps
, simply run:
Project web
is formatted following the . For this one, simply run:
Following the guidelines and update the VERSION
file before creating a PR, for instance: