README.md

HyperLeda database app

Development

To install reqired modules:

make install

To start application:

make adminapi

Tests are located in tests/, to run them and all linters:

make test-all

Before commit run:

make fix

How to contribute new code

1. Clone repository locally:

   git clone https://github.com/HyperLEDA/db-app.git

2. Create new branch for the new feature (substitute {number} for issue number associated with the feature):

   git branch issue-{number}
   git checkout issue-{number}

3. Write new code

4. Run make test-all and ensure that it completes successfully.

5. Add and commit changes:

   git add .
   git commit -m "some cool message that briefly describes what you changed and why"

6. Push changes to the repository:

   git push origin issue-{number}

7. Navigate to https://github.com and create pull request. You should see it here.

8. Wait until all checks become successfull (or fix the code if they are not).

9. Request review from the team member or merge it with master if you are sure.