docs: add CONTRIBUTING
All checks were successful
Flake checks / Check (pull_request) Successful in 2m18s
All checks were successful
Flake checks / Check (pull_request) Successful in 2m18s
This commit is contained in:
parent
aa7ab4bc6b
commit
d47e1b9e2e
3 changed files with 37 additions and 20 deletions
35
CONTRIBUTING.md
Normal file
35
CONTRIBUTING.md
Normal file
|
@ -0,0 +1,35 @@
|
|||
# Contributing guide
|
||||
|
||||
Things you'll need:
|
||||
|
||||
- To create [Pull Requests](https://forgejo.org/docs/latest/user/pull-requests-and-git-flow/), you will need to register your [pub.solar ID](https://auth.pub.solar) first.
|
||||
- For small changes, e.g. to documentation, you can directly edit files in the browser.
|
||||
|
||||
### Getting a development shell
|
||||
|
||||
First, get a local copy of this repository:
|
||||
|
||||
```
|
||||
git clone https://git.pub.solar/pub-solar/infra.git
|
||||
cd infra
|
||||
```
|
||||
|
||||
then, install [the package manager nix](https://nixos.org/download).
|
||||
|
||||
Finally, run:
|
||||
|
||||
```
|
||||
nix develop
|
||||
```
|
||||
|
||||
This will install a development shell (devshell) with all required tools.
|
||||
|
||||
### Final checks before creating a Pull Request
|
||||
|
||||
Before creating a pull request, it's recommended to check the formatting:
|
||||
|
||||
```
|
||||
treefmt
|
||||
```
|
||||
|
||||
If you are a terminal-lover, the [AGit alternative](https://forgejo.org/docs/latest/user/agit-support/) to the web based Pull Request workflow might be interesting.
|
Loading…
Add table
Add a link
Reference in a new issue