diff options
author | Vijay Aravamudhan <vraravam@users.noreply.github.com> | 2022-04-24 12:23:44 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-04-24 12:23:44 -0500 |
commit | 442ef142fc4bd7c430d8a1314535f03576f616f6 (patch) | |
tree | 10d8df84e8c5ba68b7dd0bf6bc1e0add6a766b63 /CONTRIBUTING.md | |
parent | fix: branding on README.md (diff) | |
download | ferdium-server-442ef142fc4bd7c430d8a1314535f03576f616f6.tar.gz ferdium-server-442ef142fc4bd7c430d8a1314535f03576f616f6.tar.zst ferdium-server-442ef142fc4bd7c430d8a1314535f03576f616f6.zip |
Rebranded from 'ferdi' to 'ferdium' (#4)
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r-- | CONTRIBUTING.md | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a0b4c0b..46bb4e4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md | |||
@@ -1,12 +1,12 @@ | |||
1 | # Contributing to ferdi-server | 1 | # Contributing to ferdium-server |
2 | 2 | ||
3 | :tada: First off, thanks for taking the time and your effort to make Ferdi better! :tada: | 3 | :tada: First off, thanks for taking the time and your effort to make Ferdium better! :tada: |
4 | 4 | ||
5 | ## Table of contents | 5 | ## Table of contents |
6 | 6 | ||
7 | <!-- TOC depthFrom:2 depthTo:2 withLinks:1 updateOnSave:1 orderedList:0 --> | 7 | <!-- TOC depthFrom:2 depthTo:2 withLinks:1 updateOnSave:1 orderedList:0 --> |
8 | 8 | ||
9 | - [Contributing to ferdi-server](#contributing-to-ferdi-server) | 9 | - [Contributing to ferdium-server](#contributing-to-ferdium-server) |
10 | - [Table of contents](#table-of-contents) | 10 | - [Table of contents](#table-of-contents) |
11 | - [Code of Conduct](#code-of-conduct) | 11 | - [Code of Conduct](#code-of-conduct) |
12 | - [What should I know before I get started?](#what-should-i-know-before-i-get-started) | 12 | - [What should I know before I get started?](#what-should-i-know-before-i-get-started) |
@@ -26,15 +26,15 @@ | |||
26 | 26 | ||
27 | ## Code of Conduct | 27 | ## Code of Conduct |
28 | 28 | ||
29 | This project and everyone participating in it is governed by the [Ferdi Code of Conduct](https://github.com/getferdi/ferdi/blob/develop/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [stefan@adlk.io](mailto:stefan@adlk.io). | 29 | This project and everyone participating in it is governed by the [Ferdium Code of Conduct](https://github.com/ferdium/ferdium-app/blob/develop/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [hello@ferdium.org](mailto:hello@ferdium.org). |
30 | 30 | ||
31 | ## What should I know before I get started? | 31 | ## What should I know before I get started? |
32 | 32 | ||
33 | For the moment, Ferdi's development is a bit slow but all contributions are highly appreciated. [Check this issue for discussion](https://github.com/getferdi/ferdi/issues/956). | 33 | For the moment, Ferdium's development is just getting started but all contributions (code, testing, bug-logging, feature-suggestions) are highly appreciated. |
34 | 34 | ||
35 | ## How Can I Contribute? | 35 | ## How Can I Contribute? |
36 | 36 | ||
37 | As a basic rule, before filing issues, feature requests or anything else. Take a look at the issues and check if this has not already been reported by another user. If so, engage in the already existing discussion. | 37 | As a basic rule, before filing issues, feature requests or anything else, please take a look at the issues and check if this has not already been reported by another user. If so, engage in the already existing discussion. |
38 | 38 | ||
39 | ## Setting up your Development machine | 39 | ## Setting up your Development machine |
40 | 40 | ||
@@ -83,16 +83,16 @@ npm i -g windows-build-tools --vs2015 | |||
83 | ### Clone repository with submodule | 83 | ### Clone repository with submodule |
84 | 84 | ||
85 | ```bash | 85 | ```bash |
86 | git clone https://github.com/getferdi/server.git | 86 | git clone https://github.com/ferdium/ferdium-server.git |
87 | cd server | 87 | cd ferdium-server |
88 | git submodule update --init --recursive | 88 | git submodule update --init --recursive --remote --rebase --force |
89 | ``` | 89 | ``` |
90 | 90 | ||
91 | It is important you execute the last command to get the required submodules (recipes). | 91 | It is important you execute the last command to get the required submodules (recipes). |
92 | 92 | ||
93 | ### Install dependencies | 93 | ### Install dependencies |
94 | 94 | ||
95 | - Run the following command to install all dependencies, and link sibling modules with ferdi-server. | 95 | - Run the following command to install all dependencies, and link sibling modules with ferdium-server. |
96 | 96 | ||
97 | ```bash | 97 | ```bash |
98 | npm i | 98 | npm i |