CONTRIBUTING.md

Contributing

Interested in contributing? Awesome!

1. Making changes
2. Adding a template
3. Editing a template

Making changes

1. Install Rust
2. Install wkhtmltopdf
3. Make the desired changes
4. Run cargo test to run tests
5. Install Clippy and run cargo clippy to check for linter errors
6. Run cargo run -- <command> to see the effects of your changes on the CLI, e.g., cargo run -- init --template <template> or cargo run -- build --watch
7. Submit a PR!

Adding a template

1. Follow the instructions to set up your computer
2. Create a directory for your new template in the templates directory containing two files: resume.pug and styles.css
   • Alternatively, you may copy from an existing template directory, e.g., templates/basic
3. Update src/templates.rs to add your new template
   • Don't know much Rust? Follow the pattern set by an existing template (e.g., BASIC)
4. Follow the instructions for editing a template to edit your new template

Editing a template

1. Follow the instructions to set up your computer
2. Run resufancy init --template <template name> to start a resume based on the template you want to edit
3. Edit resume.pug and styles.css as desired, running resufancy build --watch to see the effects of your changes
4. Once ready, copy resume.pug and styles.css back into templates/<template>