This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code.
We use yarn as our package manager.
The basic commands to get this repository and start are:
$ git clone https://github.com/cs130-w21/book.ar.git
$ cd book.ar
$ yarn install
$ yarn start
If you run into an issue, feel free to make an issue here. If you have a fix, even better! Check out the follow section to learn how to contribute!
Thanks for your interest in contributing to book.ar! ❤️
Here's a quick guide on how to get started.
- Fork the repository or checkout a branch;
mainis protected and is managed through our pipeline. - Create an issue and/or mark an existing one to let everyone know that you are working your magic ⚡️
- Beep boop away!
- Before you push, it's always a good idea to check that your changes follow our linter rules! Run
yarn lintat the root directory and watch it judge your code. - Stage, commit, and push your changes to make a pull request!
- A maintainer will review your code and if it passes all the checks, your contribution will be merged on to
main🥳
See CONTRIBUTING.md and DESIGN_GUIDELINES.md for more info.
If you ever need help with a feature or bug fix, no worries! Feel free to mark the issue as
guidance so that our maintainers can start thinking about a solution. If you are
comfortable making a draft pull request,
you can also tag the book.ar team in a comment: @cs130-w21/14!