Contributing

Review the Code of Conduct.

Where to start

View issues tagged with the Good First Issues label to find good first feature requests and bugs to fix.

Visit https://github.com/sadanandpai/resume-builder/issues to view all issues.

Development

Running the environment locally or in Docker

Run the environment locally or in Docker by following the instructions at Running the environment.

Creating a template

TODO(sadanandpai): Per issue #175, add instructions for how to create a template.

Submit a change

Fork the repo.
Clone the forked repo.
```
$ git clone FORKED_REPO
```
Install the dependencies
```
$ npm install
```
Check out a new branch based and name it to what you intend to do:
```
$ git switch -c BRANCH_NAME
```
Run the project
```
$ npm run dev
```
Commit your changes
1. Commit to the forked repository
```
$ git commit -am 'Add some proper message'
```
  Please provide a git message that explains what you've done.
2. Push to the branch
```
$ git push origin BRANCH_NAME
```
3. Make a pull request (PR). Ensure you send the PR to the main branch
Once done, our developer will review the changes and merge to main branch.