Contributing Guide
How to help build the future of VeriWorkly.
Contributing to VeriWorkly
First off, thank you for considering contributing to VeriWorkly! We are building a professional, privacy-first career ecosystem, and we value your help.
Getting Started
To ensure a smooth workflow, please follow these steps to set up your environment:
- Fork the repository on GitHub.
- Clone your fork locally:
git clone https://github.com/Gautam25Raj/veriworkly-resume.git cd veriworkly-resume - Set up your local environment following our Local Setup Guide.
- Create a branch for your work:
git checkout -b feat/your-feature-name
Ways to Contribute
1. Code Contributions
We love new features and bug fixes! Check our GitHub Issues for "good first issue" labels if you're new to the project.
2. Design & Templates
Our template system is designed to be extensible. If you're a designer or frontend developer, you can contribute new professional, ATS-optimized layouts.
3. Documentation
A great project needs great docs. If you find a typo, a confusing explanation, or want to add a new guide, please open a PR!
4. Bug Reports
If you find a bug, please open an issue with:
- A clear, descriptive title.
- Steps to reproduce the issue.
- Expected vs. actual behavior.
- Screenshots if applicable.
Development Workflow
Branching Policy
main: This branch contains the latest stable, production-ready code.dev: This is the active development and integration branch. All Pull Requests should be opened againstdev.
Branch Naming Convention
feat/feature-name: For new features.fix/bug-name: For bug fixes.docs/doc-update: For documentation changes.refactor/scope: For code refactoring without behavior changes.
Technical Standards
Deep dive into our engineering practices and standards: