Skip to content

Commit 847dbab

Browse files
committed
docs: Add CONTRIBUTING.md
A `CONTRIBUTING.md` is considered a good practice for open source projects. It helps developers to get started quickly. It clearly doesn't replace the already existing guide for content contributors. The `CONTRIBUTING.md` is only focused on developers.
1 parent 3a3c196 commit 847dbab

1 file changed

Lines changed: 49 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Contributing
2+
3+
Thanks for your interest in the FIP guide. Contributions are always welcome!
4+
5+
This guide is intended for developers.
6+
If you just want to contribute content, you can find more information in the [Wiki](/../../wiki/English).
7+
8+
We are committed to fostering a welcoming, respectful, and harassment-free
9+
environment. Be kind!
10+
If you have questions, ideas or want to report a bug, feel free to
11+
[open an issue](/../../issues). Or go ahead and
12+
[open a pull request](/../../pulls) to contribute code.
13+
14+
## Getting Started
15+
16+
### Prerequisites
17+
18+
The project uses Hugo as framework for the website. Therefore, hugo must first be installed.
19+
You can find the instructions in the official [Hugo documentation](https://gohugo.io/installation/).
20+
21+
Validate the installation by running `hugo version` in the command line.
22+
23+
In addition, we use some node packages, for example bootstrap as UI toolkit. To install the packages,
24+
install the node package manager `npm` on your machine. Instructions are available in the [official documentation](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).
25+
26+
Validate the installation by running `npm --version` in the command line.
27+
28+
### Start the development server
29+
30+
First of all, we have to the install the node packages by running:
31+
32+
```zsh
33+
npm i
34+
```
35+
36+
Then, we can start the integrated hugo server with:
37+
38+
39+
```zsh
40+
hugo server
41+
```
42+
43+
Check the output and follow the link to see a local preview of the changes.
44+
45+
To initialize the search index, run the following command in a separate terminal window:
46+
47+
```zsh
48+
npx -y pagefind --site public
49+
```

0 commit comments

Comments
 (0)