Thank you for considering contributing to Compass Web Service! We welcome contributions of all kinds, from bug fixes to new features.
- Please follow the code of conduct when interacting with the project community.
- Ensure that your code adheres to the project's style guidelines.
- Write clear and concise commit messages.
- Provide tests for your changes.
- Submit your changes as pull requests.
- Clone the repository:
git clone https://github.com/open-metrics-code/compass-web-service
cd compass-web-service
- Copy the example environment file:
cp .env.example .env.local
- Setup the project:
rails db:setup
rails db:migrate
- Start the project:
rails s
To start a scheduled task service that regularly updates project reports and summary reports, run the following command:
bundle exec crono -e development
To start an asynchronous task queue for checking repository validity, handling exceptional requests, etc., run the following command:
bundle exec rake rabbitmq:start
When submitting a pull request, please include the following information:
- A brief description of the changes you have made.
- A reference to any relevant issues or discussions.
- Any tests or benchmarks that you have performed.
All pull requests will be reviewed by at least one other contributor before being merged. Please be patient during the review process.