Submitting Specifications

Skicka in specifikationer / Submitting Specifications

How to submit your completed specification for review.

Overview / Översikt

Specifications are submitted via GitLab Merge Requests (MR). This ensures:

• Version control of all specs
• Review process before acceptance
• Clear history of changes

Step-by-Step Guide / Steg-för-steg

1. Save Your Spec

Save your specification to:

docs/product/specs/your-feature-name.md

Use lowercase with hyphens for the filename:

• lead-status-filter.md
• quotation-pdf-export.md
• customer-portal-progress.md

2. Create a Branch

Open terminal in the vulcan-docs folder:

git checkout -b spec/your-feature-name

3. Stage Your Changes

git add docs/product/specs/your-feature-name.md

4. Commit

git commit -m "spec: add your-feature-name specification"

Use the spec: prefix for specification commits.

5. Push to GitLab

git push -u origin spec/your-feature-name

6. Create Merge Request

1. Go to GitLab: gitlab.hantverksdata.se/vulcan/vulcan-docs
2. Click "Create merge request"
3. Fill in:
   • Title: spec: Your Feature Name
   • Description: Brief summary of the feature
   • Assignee: Assign to a reviewer
4. Click "Create merge request"

Merge Request Template / MR-mall

## Summary / Sammanfattning

[Brief description of the feature specification]

## Checklist

- [ ] Spec follows template structure
- [ ] Problem statement is clear
- [ ] Acceptance criteria are testable
- [ ] Priority is set
- [ ] Module is identified

After Submission / Efter inlämning

1. Review - A team member will review your spec
2. Feedback - You may receive comments or questions
3. Revisions - Update your spec if needed
4. Merge - Once approved, the spec is merged

Quick Reference / Snabbreferens

# Full workflow
git checkout -b spec/feature-name
git add docs/product/specs/feature-name.md
git commit -m "spec: add feature-name specification"
git push -u origin spec/feature-name
# Then create MR in GitLab

Getting Help / Få hjälp

If you're unfamiliar with Git:

• Ask a developer to help with the submission
• Or send your spec file directly to the team for manual submission

Tips

• One spec per MR - Keep merge requests focused
• Descriptive names - Use clear, searchable filenames
• Update don't duplicate - Edit existing specs rather than creating new ones