Improve contributing docs

Signed-off-by: Marco Ambrosini <marcoambrosini@pm.me>
This commit is contained in:
Marco Ambrosini 2020-03-31 15:47:40 +02:00
parent fa4162e86f
commit 4d51ed3918
2 changed files with 62 additions and 1 deletions

61
DEVENV.md Normal file
View File

@ -0,0 +1,61 @@
## Spin-up a quick nextcloud development instance 🚀
### 1) Install the required packages ⛑
* [php](https://www.php.net/manual/en/install.php)
* php-gd
* php-sqlite
---
### 2) Edit php.ini file to enable the installed extensions 🧰
```
sudo nano /etc/php/php.ini
```
Comment out `extension=gd` and `extension=pdo_sqlite`
---
### 3) Get nextcloud ☁️
Clone the server repository:
```
git clone https://github.com/nextcloud/server.git
```
Update third party modules:
```
cd server
```
```
git submodule update --init
```
---
## 4) Start server 🌐
From within the server folder, execute:
```
php -S 0.0.0.0:80
```
---
## 5) Type 'localhost' in your browser and enjoy contributing! 🥂 🎉
---
### Install apps 👾
\- If you want to install apps, you can directly go into your apps management;
\- **but** if you want to work on apps development, just clone their git repository into the apps folder in the server folder;
### Note: this is not an ideal permanent development environment. For a more stable and reliable platform, [please follow these instructions](https://docs.nextcloud.com/server/latest/developer_manual/general/devenv.html))

View File

@ -45,7 +45,7 @@ There are many ways to contribute, of which development is only one! Find out [h
### Development setup 👩‍💻
1. 🚀 [Set up your local development environment](https://docs.nextcloud.com/server/latest/developer_manual/general/devenv.html)
1. 🚀 [Set up your local development environment](./DEVENV.md)
2. 🐛 [Pick a good first issue](https://github.com/nextcloud/server/labels/good%20first%20issue)
3. 👩‍🔧 Create a branch and make your changes. Remember to sign off your commits using `git commit -sm "Your commit message"`
4. ⬆ Create a [pull request](https://opensource.guide/how-to-contribute/#opening-a-pull-request) and `@mention` the people from the issue to review