Skip to content

Latest commit

 

History

History
83 lines (69 loc) · 3.8 KB

CONTRIBUTING.md

File metadata and controls

83 lines (69 loc) · 3.8 KB
Raw

Contributing

Table of Contents

Setup

You'll need to install a few applications to contribute to this project:

  • Git - This is used for version control

  • Git Large File Storage (LFS) - This is used to store the Gradle Wrapper JAR without using up too much space.

  • Docker - This is used to run the application in both production and development. Ideally it would not be necessary, but for now it is, to reduce the need to download an infinite number of dependencies all the time.

  • Java Development Kit - The project is written in Java, so you'll probably need to install a Java Development Kit (JDK) in order to build and run it.

    NOTE: Please use at least version 17 and at most version 19. This project uses Java 17 features, so at least JDK 17 is required, but Gradle 7 doesn't support anything later than 19, so you will not be able to build code if you install JDK 20.

  • NodeJS and Yarn - This project uses Yarn and NodeJS for compiling JavaScript and also for running custom build commands.

NOTE: If you're on MacOS, you may need to do additional work to set up your computer. Open the Terminal App and run the following command:

xcode-select --install

Development

Repository

  • Fork this repository by clicking fork on the right side.
  • Choose where you want to save the project locally on your computer then run git clone [Your URL/Git here].
  • We recommend to develop your feature through another branch other than the main branch. So, run git checkout -b [name of your branch here] and develop the feature. You can switch between branches by the same command by removing -b.
  • Once you finish, you can run the normal git add, git commit & git push.
  • Make a PR when the feature is fully finished or if you would like feedback on your changes.

Build with Command Line/Terminal

  • yarn compile: Check the application for compile-time errors
  • yarn test: Test the code for regressions
  • yarn start: Start up development servers; Schedge will start on port 4358
  • yarn build: Build the application, and update the development server
  • yarn stop: Close the servers when development is done

Useful Commands

  • yarn schedge db populate sp2022 - Populate your database with data from production
  • docker-compose postgres psql --dbname=postgres --host=localhost --port=5432 --username=postgres - Run psql on the local database

Testing

  • yarn test will test the backend; before running tests, please run the command yarn schedge db test-populate in order to populate the database with the necessary test data.

Comment Annotations

The codebase uses the following annotations in the comments:

  • @Help - Help wanted
  • @TODO - Code has something that's yet to be done
  • @Note - A note for readers
  • @Performance - This area can be tweaked/rewritten to improve performance
  • @Organize - We should reorganize this code

Before Creating a PR

  • Make sure that the code compiles and test your code.
  • Format your code with clang-format.