This is a repository for the Cycloop portal, available at https://cycloop.bike.
Other repositories:
Visit the website at https://cycloop.bike.
- Fork this repository at https://github.com/sportloop/cycloop-portal.
- Clone your forked repository.
- Install dependencies -
yarn install. - Start the application locally -
yarn develop. - Visit your copy of the application at http://0.0.0.0:3000.
This repository is hooked up with husky, lint-staged and commitlint, which runs eslint and checks your commit message before commiting changes. To comply with these rules, you can make sure eslint is properly set up in your IDE (e.g.: in VSCode it should work automatically) and errors in your changes will be highlighted. Commit messages follow conventional commit standard. Commits will be squashed before they enter master, so make sure to create a pull request for each meaningful change you'd like to distinguish.
If there's a ticket describing the issue your PR resolves make sure you link that ticket number in your PR description, title, or in one of the commits. You should point your PR to master branch for new features and bug fixes in production.
Once you submit your PR, Now will automatically deploy your changes to a unique URL that you can visit to test those changes in a real environment.
Your PR will be accepted after review. Once this happens you will get a chance to join the development team on GitHub, which will change your workflow somewhat. You will be able to create branches in the main repository and have access to more private discussions about the project. Do not feel an obligation to accept this, but know that this being a fully open source and not-funded project your contribution is greatly appreciated.