Skip to content

Commit e65ff86

Browse files
committed
feat: enhance resume editor settings and import functionality
- Updated SettingControls component to improve layout and hint display. - Refactored SettingsSelect to use a custom select element with a dropdown icon. - Enhanced SettingsRange to visually represent range progress and display current value. - Improved SettingsColor to show selected color and its hex value. - Added resume-markdown-import service for importing resumes from markdown files. - Integrated markdown import functionality into resume service. - Updated cover letter templates to conditionally render sections based on visibility settings. - Introduced isCoverLetterSectionVisible utility to manage section visibility in cover letters.
1 parent 4e2305a commit e65ff86

49 files changed

Lines changed: 2262 additions & 1128 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

CONTRIBUTING.md

Lines changed: 40 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,21 @@ First off, thank you for considering contributing to **VeriWorkly**! We are buil
1010
1111
---
1212

13-
## Quick TL;DR Contribution Workflow
13+
## ⚡ Contribution Workflow
1414

15-
If you just need a quick heads-up on the commands and branching protocol:
15+
Follow these steps to contribute code or documentation to VeriWorkly:
1616

17-
### 1. Fork & Clone
17+
### 1. Star the Repository 🌟
18+
19+
Before getting started, please **star our repository** to show your support for the project!
20+
21+
### 2. Claim an Issue 📋
22+
23+
- Browse our open issues.
24+
- If you find an issue you want to work on, comment on it expressing your interest and wait to be officially assigned by a maintainer.
25+
- ⚠️ **Do not start coding or open a Pull Request before being assigned to the issue.** Unassigned PRs or PRs targeting unclaimed issues may be closed without review to avoid duplicate work.
26+
27+
### 3. Fork & Clone 🍴
1828

1929
1. Fork the [original repository](https://github.com/VeriWorkly/veriworkly).
2030
2. Clone your fork locally:
@@ -27,77 +37,56 @@ If you just need a quick heads-up on the commands and branching protocol:
2737
git remote add upstream https://github.com/VeriWorkly/veriworkly.git
2838
```
2939

30-
### 2. Branching Policy
40+
### 4. Branching Policy 🌿
3141

32-
- **Base Branch**: PRs must be based on and target the **`master`** branch.
33-
- **Update your branch** before starting:
42+
- PRs must be based on and target the **`master`** branch.
43+
- Keep your fork in sync and create a descriptive feature branch:
3444
```bash
3545
git checkout master
3646
git pull upstream master
3747
git checkout -b feat/your-feature-name
3848
```
49+
- **Branch Naming Convention**:
50+
- `feat/feature-name` (new features/enhancements)
51+
- `fix/bug-name` (bug fixes)
52+
- `docs/doc-update` (documentation changes)
53+
- `refactor/scope-of-work` (restructuring/refactoring code)
3954

40-
### 3. Local Run Commands
55+
### 5. Local Setup & Verification 🛠️
4156

4257
- Install dependencies: `npm install`
4358
- Copy environment variables: `cp .env.example .env` and `cp apps/server/.env.example apps/server/.env`
44-
- Choose your dev flow:
45-
- **Frontend-only (Site/Templates at port 3000)**: `npm run dev` _(No database or backend server needed)_
59+
- Run the app locally to test your changes:
60+
- **Frontend-only (Site/Templates at port 3000)**: `npm run dev`
4661
- **Full-stack (All apps/databases)**: `npm run dev:all` _(Requires running `npm run db:push -w @veriworkly/server`)_
4762

48-
### 4. Code Quality
49-
50-
Run checks before committing:
51-
52-
```bash
53-
npm run dev:all
54-
```
55-
5663
---
5764

58-
## 🌿 Branching Policy
65+
## 📝 Pull Request Guidelines
5966

60-
- `master`: Active development, integration, and production branch. **Base your PRs here.**
67+
To ensure smooth reviews and fast merges, please adhere to these PR guidelines:
6168

62-
### Branch Naming Convention
69+
### 1. PR Title Naming Convention
6370

64-
- `feat/feature-name`
65-
- `fix/bug-name`
66-
- `docs/doc-update`
67-
- `refactor/scope-of-work`
71+
PR titles **must** follow the format:
6872

69-
---
70-
71-
## 🛠️ Development Guidelines
72-
73-
### 1. Architecture
74-
75-
We use a **Monorepo** structure.
76-
77-
- **apps/site**: Marketing landing site.
78-
- **apps/studio**: Builder studio application.
79-
- **apps/server**: Express API.
80-
- **apps/docs-platform**: Documentation (Fumadocs).
81-
- **packages/ui**: Shared Design System.
73+
```
74+
[Type] [App/Component]: <lowercase description>
75+
```
8276

83-
### 2. Coding Standards
77+
- **Type**: `[Fix]`, `[Feature]`, `[Refactor]`, `[Docs]`, `[Chore]`
78+
- **App/Component**: `[Studio]`, `[Server]`, `[Site]`, `[UI]`, etc.
79+
- **Example**: `[Fix] [Studio]: hide auth-only actions in account menu for anonymous users`
8480

85-
- **TypeScript**: Mandatory for all new code.
86-
- **Linting**: Run `npm run lint` before committing.
87-
- **Formatting**: We use Prettier. Run `npm run format:write`.
81+
### 2. Linking Issues
8882

89-
---
83+
- You **must link the issue** your PR addresses in the PR description using the hashtag format (e.g., `Fixes #123` or `Closes #123`). This allows GitHub to automatically associate and close the issue upon merge.
9084

91-
## 📝 Pull Request Process
85+
### 3. Complete the PR Template & Checklist
9286

93-
1. **Create an Issue**: Discuss large changes before starting work.
94-
2. **Submit PR**: Open a PR against the `master` branch.
95-
3. **Checklist**:
96-
- [ ] Lint passes (`npm run lint`)
97-
- [ ] Prettier formatting succeeds (`npm run format:write`)
98-
- [ ] Code builds successfully (`npm run build`)
99-
- [ ] Tests pass (`npm test`)
100-
- [ ] Documentation updated (if applicable)
87+
- When opening a PR, fill out the template fully.
88+
- Complete the checkbox checklist in the PR body by replacing `[ ]` with `[x]` for items you have done (e.g., linting, formatting, tests).
89+
- ⚠️ **PRs with empty, uncompleted checklists will not be reviewed.**
10190

10291
---
10392

0 commit comments

Comments
 (0)