From 7701b07f711d6f865db1eae1a1e29512b71acb67 Mon Sep 17 00:00:00 2001 From: ih8js-git <141177946+ih8js-git@users.noreply.github.com> Date: Tue, 8 Sep 2026 08:43:24 -0500 Subject: [PATCH] docs: add contributing guidelines --- .github/workflows/aur.yml | 1 + CONTRIBUTING.md | 36 ++++++++++++++++++++++++++++++++++++ 2 files changed, 37 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/.github/workflows/aur.yml b/.github/workflows/aur.yml index 289f3bf..214b707 100644 --- a/.github/workflows/aur.yml +++ b/.github/workflows/aur.yml @@ -18,6 +18,7 @@ jobs: matrix: include: - pkgname: vimstoat + - pkgname: vimstoat-bin - pkgname: vimstoat-git steps: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..3994e79 --- /dev/null +++ b/CONTRIBUTING.md @@ -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: `: ` + +Common types: +- `fix: ` — Bug fixes (e.g. `fix: the thing`) +- `feat: ` — New features +- `docs: ` — Documentation changes +- `refactor: ` — Code refactoring without behavioral changes +- `test: ` — Adding or updating tests +- `chore: ` — Routine tasks, dependencies, or maintenance + +**Example:** +* `fix: the thing` +* `feat: add support for custom keybindings` + +Thanks for helping make this project better!