forked from pub-solar/infra
docs: add CONTRIBUTING
This commit is contained in:
parent
aa7ab4bc6b
commit
d47e1b9e2e
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.
|
|
@ -6,6 +6,6 @@ The architecture we are working towards is a vast simplification of what it was
|
|||
|
||||
## Contributing
|
||||
|
||||
If you'd like to contribute, it makes sense to talk to the crew on Matrix via [#hakken](https://matrix.to/#/#hakken:pub.solar?via=chat.pub.solar). We can help figuring out how things work and can make sure your ideas fit the pub.solar philosophy. Of course [popping a pull request](https://docs.gitea.com/next/usage/pull-request#creating-a-pull-request) is always celebrated.
|
||||
If you'd like to contribute, it makes sense to talk to the crew on Matrix via [#hakken](https://matrix.to/#/#hakken:pub.solar?via=chat.pub.solar). We can help figuring out how things work and can make sure your ideas fit the pub.solar philosophy. Of course [popping a pull request](https://forgejo.org/docs/latest/user/pull-requests-and-git-flow/) is always celebrated.
|
||||
|
||||
To start, see [how to get a development shell](./docs/development-shell.md).
|
||||
To start, check our [contributing guide](./CONTRIBUTING.md).
|
||||
|
|
|
@ -1,18 +0,0 @@
|
|||
# Getting a development shell
|
||||
|
||||
Clone 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.
|
Loading…
Reference in a new issue