Skip to content

Latest commit

 

History

History
85 lines (54 loc) · 2.5 KB

CONTRIBUTING.md

File metadata and controls

85 lines (54 loc) · 2.5 KB
Raw

Contribute to LSALab website

We highly appreciate your effort to contribute, you can talk to us or just create a pull request then I will give it a review!!

Feature Requests

Feature Requests are highly encouraged. Feel free to submit a new one.

Bugs

We are using GitHub issues to manage bugs. We keep a close eye on them. Before filing a new issue, try to ensure your problem does not already exist.

Before Submitting a Pull Request

We will review your pull request and either merge it, request changes, or close it.

Contribution Prerequisites

  • You have Node.js at version >= v14 and <= v16, Yarn at v1.2.0+, and Docker installed.
  • You are familiar with Git.

Before submitting your pull request make sure the following requirements are fulfilled:

  • Fork the repository and create your new branch from main.
  • Run yarn setup in the root of the repository.
  • If you've fixed a bug or added code that should be tested, please make sure to add tests
  • Ensure the following test suites are passing:
    • yarn test:front
    • yarn test:back
  • Make sure your code lints by running yarn lint.
  • If your contribution fixes an existing issue, please make sure to link it in your pull request.

Development Workflow

1. Fork the repository

Go to the repository and fork it using your own GitHub account.

2. Clone your repository

git clone [email protected]:YOUR_USERNAME/lsalab-web.git

3. Install the dependencies

Go to the root of the repository and run the setup:

cd lsalab-web
yarn setup

4. Start the application

# For linux
docker/run.sh
# For MacOS
docker/macos/run.sh
yarn dev

5. Modify environment variable files

TODO

The frontend should now be available at http://localhost:3000/ while the backend at http://localhost:1337

Awesome! You are now able to contribute to LSALab website.

6. Available commands

  • yarn build builds the frontend and administration panel.
  • yarn setup installs dependencies.
  • yarn lint lints the codebase.
  • yarn test:front runs front-end related tests.
  • yarn test:back runs the back-end unit tests.