From 77e3c72ef84d1ff3a35431000e995d397d22ac2c Mon Sep 17 00:00:00 2001 From: Benedikt Peetz Date: Wed, 25 Dec 2024 17:18:05 +0100 Subject: docs(CONTRIBUTING.md): Remove The information is currently out-dated, was never really up-to-date and as such will not provide anything useful to new contributors. We should probably try to write it again at some point when our workflow has moved more from cathedral to bazaar. --- CONTRIBUTING.md | 24 ------------------------ 1 file changed, 24 deletions(-) delete mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 330cbeb..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,24 +0,0 @@ -# Branches -Following branches are used: -## develop -This contains all upcoming changes for the next pull request to `main`. -All feature branches should merge into this branch. -## feature branches -These branches are created on a per-feature basis and will be merged into `develop`. This merge happens without ci testing and prior review, but a pull request should be opened to trigger a notification. -## main -Changes in this branch trigger an automatic rebuild on the server, so all merges should be peer-reviewed and tested. However, exceptions can be made for changes, which close security vulnerabilities. -The only branch able to be merged into `main` is `develop`. - -# Development process -If adding a new feature you should follow this loose guide: -1. Clone the repository -1. Allow the `.envrc`: `direnv allow` (see [development environment](#development-environment), if you don't know what this does) -1. Checkout your feature branch from develop: `git checkout -b develop` -1. Actually make the changes -1. Commit them, while following conventional commits (See [their docs](https://www.conventionalcommits.org/en/v1.0.0/) for further guidance) -1. Push your change and open a pull request to `develop`: `git push --set-upstream origin ` - -# Development environment -All required tools should be specified in the `devShells` output of the flake. This is because we use [Direnv](https://github.com/direnv/direnv) in combination with [Nix integration](https://github.com/direnv/direnv/wiki/Nix) — in this case [Nix-direnv](https://github.com/nix-community/nix-direnv) — to enforce reliable development environments (and some uncluttering of PATH). - -Setting it up is rather easy, just see [Nix-direnv's install instructions](https://github.com/nix-community/nix-direnv#installation). -- cgit 1.4.1