Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/aur.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ jobs:
matrix:
include:
- pkgname: vimstoat
- pkgname: vimstoat-bin
- pkgname: vimstoat-git

steps:
Expand Down
36 changes: 36 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Contributing Guide

First off, thank you for considering contributing to vimstoat!

## Pull Request Process

**CRITICAL:** All Pull Requests MUST be made against the `staging` branch.

Do **NOT** open Pull Requests directly against the `main` branch. The `main` branch is reserved for production releases only.

### Steps to Contribute:
1. Fork the repository.
2. Create a new branch off `staging` for your feature or bugfix.
3. Make your changes and commit them using standard naming practices (e.g. `fix: the thing`).
4. Push your branch to your fork.
5. Open a Pull Request targeting the `staging` branch of the upstream repository using the same naming format for your PR title.

## Commit & PR Naming Conventions

Standard naming practices (Conventional Commits) are advised for both commit messages and PR titles:

Format: `<type>: <description>`

Common types:
- `fix: <description>` — Bug fixes (e.g. `fix: the thing`)
- `feat: <description>` — New features
- `docs: <description>` — Documentation changes
- `refactor: <description>` — Code refactoring without behavioral changes
- `test: <description>` — Adding or updating tests
- `chore: <description>` — Routine tasks, dependencies, or maintenance

**Example:**
* `fix: the thing`
* `feat: add support for custom keybindings`

Thanks for helping make this project better!
Loading