diff options
| -rw-r--r-- | README.md | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/README.md b/README.md index f955bdb10f3..104564a4cee 100644 --- a/README.md +++ b/README.md @@ -9,18 +9,18 @@ ## Why is this so awesome? π€© -* π **Access your Data** You can store your files, contacts, calendars and more on a server of your choosing. -* π **Sync your Data** You keep your files, contacts, calendars and more synchronized amongst your devices. +* π **Access your Data** You can store your files, contacts, calendars, and more on a server of your choosing. +* π **Sync your Data** You keep your files, contacts, calendars, and more synchronized amongst your devices. * π **Share your Data** β¦by giving others access to the stuff you want them to see or to collaborate with. * π **Expandable with hundreds of Apps** ...like [Calendar](https://github.com/nextcloud/calendar), [Contacts](https://github.com/nextcloud/contacts), [Mail](https://github.com/nextcloud/mail), [Video Chat](https://github.com/nextcloud/spreed) and all those you can discover in our [App Store](https://apps.nextcloud.com) * π **Security** with our encryption mechanisms, [HackerOne bounty program](https://hackerone.com/nextcloud) and two-factor authentication. -You want to learn more about how you can use Nextcloud to access, share and protect your files, calendars, contacts, communication & more at home and at your organization? [**Learn about all our Features**](https://nextcloud.com/athome/). +Do you want to learn more about how you can use Nextcloud to access, share and protect your files, calendars, contacts, communication & more at home and in your organization? [**Learn about all our Features**](https://nextcloud.com/athome/). ## Get your Nextcloud π - βοΈ [**Simply sign up**](https://nextcloud.com/signup/) at one of our providers either through our website or through the apps directly. -- π₯ [**Install** a server by yourself](https://nextcloud.com/install/#instructions-server) on your own hardware or by using one of our ready to use **appliances** +- π₯ [**Install** a server by yourself](https://nextcloud.com/install/#instructions-server) on your hardware or by using one of our ready to use **appliances** - π¦ Buy one of the [awesome **devices** coming with a preinstalled Nextcloud](https://nextcloud.com/devices/) - π’ Find a [service **provider**](https://nextcloud.com/providers/) who hosts Nextcloud for you or your company @@ -38,7 +38,7 @@ You can also [get support for Nextcloud](https://nextcloud.com/support)! ## Join the team πͺ -There are many ways to contribute, of which development is only one! Find out [how to get involved](https://nextcloud.com/contribute/), including as translator, designer, tester, helping others and much more! π +There are many ways to contribute, of which development is only one! Find out [how to get involved](https://nextcloud.com/contribute/), including as a translator, designer, tester, helping others, and much more! π ### Development setup π©βπ» @@ -47,7 +47,7 @@ There are many ways to contribute, of which development is only one! Find out [h 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 -5. π Fix things that come up during review +5. π Fix things that come up during a review 6. π Wait for it to get merged! Third-party components are handled as git submodules which have to be initialized first. So aside from the regular git checkout invoking `git submodule update --init` or a similar command is needed, for details see Git documentation. @@ -60,7 +60,7 @@ Otherwise, git checkouts can be handled the same as release archives, by using t #### Building -We are moving more and more towards using Vue.js in the frontend, starting with Settings. For building the code on changes, use these terminal commands in the root folder: +We are moving more and more toward using Vue.js in the front-end, starting with Settings. For building the code on changes, use these terminal commands in the root folder: ```bash # install dependencies @@ -80,7 +80,7 @@ make build-js-production **When making changes, also commit the compiled files!** -We still use Handlebars templates some places in Files and Settings. We will replace these step-by-step with Vue.js, but in the meantime you need to compile them separately. +We still use Handlebars templates in some places in Files and Settings. We will replace these step-by-step with Vue.js, but in the meantime, you need to compile them separately. If you donβt have Handlebars installed yet, you can do it with this terminal command: ```bash @@ -107,7 +107,7 @@ Please note that if you used `make build-js` or `make watch-js` before, you'll n ### Working with back-end code π -When changing back-end PHP code, in general no additional steps are needed before checking in. +When changing back-end PHP code, in general, no additional steps are needed before checking in. However, if new files were created, you will need to run the following command to update the autoloader files: ```bash @@ -120,17 +120,17 @@ After that, please also include the autoloader file changes in your commits. - [π BrowserStack](https://browserstack.com) for cross-browser testing - [π WAVE](https://wave.webaim.org/extension/) for accessibility testing -- [π¨ Lighthouse](https://developers.google.com/web/tools/lighthouse/) for testing of performance, accessibility and more +- [π¨ Lighthouse](https://developers.google.com/web/tools/lighthouse/) for testing performance, accessibility, and more ## Contribution guidelines π -All contributions to this repository from June, 16 2016 on are considered to be +All contributions to this repository from June 16, 2016, and onward are considered to be licensed under the AGPLv3 or any later version. Nextcloud doesn't require a CLA (Contributor License Agreement). The copyright belongs to all the individual contributors. Therefore we recommend -that every contributor adds following line to the header of a file, if they +that every contributor adds the following line to the header of a file if they changed it substantially: ``` |