CopterExpress/clover
1
0
Fork 0
mirror of https://github.com/CopterExpress/clover.git synced 2026-06-07 10:04:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

Continue renaming to Clover

Browse Source
This commit is contained in:
Oleg Kalachev
2020-04-30 03:41:14 +03:00
parent 77ca50b901
commit a480ebe80a
88 changed files with 271 additions and 273 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/en/contributing.md
View File

@@ -1,12 +1,12 @@
# Contribution to Clever
# Contribution to Clover
Clever is mostly an [open source](https://en.wikipedia.org/wiki/Open-source_software) and [open hardware](https://en.wikipedia.org/wiki/Open-source_hardware) project aimed at lowering the entry threshold to development of the projects related to flying robotics. You can contribute to the project by offering fixes and improvements for Clever documentation and software.
Clover is mostly an [open source](https://en.wikipedia.org/wiki/Open-source_software) and [open hardware](https://en.wikipedia.org/wiki/Open-source_hardware) project aimed at lowering the entry threshold to development of the projects related to flying robotics. You can contribute to the project by offering fixes and improvements for Clover documentation and software.
> **Note** To offer changes to Clever documentation or SW, you should have an account at [GitHub](https://github.com).
> **Note** To offer changes to Clover documentation or SW, you should have an account at [GitHub](https://github.com).
## Markdown
All Clever documentation is written in the widespread [Markdown](https://en.wikipedia.org/wiki/Markdown) format. There are many Markdown guides on the Internet.
All Clover documentation is written in the widespread [Markdown](https://en.wikipedia.org/wiki/Markdown) format. There are many Markdown guides on the Internet.
In Russian: https://guides.hexlet.io/markdown/.
@@ -22,7 +22,7 @@ For a local build of a static documentation website, use the [`gitbook-cli`](htt
If you have found an error in the documentation or if you want to improve it, use the **Pull Request** mechanism.
1. Find a file with the article you want in the repository – https://github.com/CopterExpress/clever/tree/master/docs.
1. Find a file with the article you want in the repository – https://github.com/CopterExpress/clover/tree/master/docs.
2. Click "Edit".
<img src="../assets/github-edit.png" alt="GitHub Edit">
@@ -36,18 +36,18 @@ More information about Pull Requests is available [at GitHub](https://help.githu
## Contributing a new article
> **Note** If you've made your own project based on Clever, you can add an article about it to the "Clever-based projects" section.
> **Note** If you've made your own project based on Clover, you can add an article about it to the "Clover-based projects" section.
Prepare your article and send it as a pull request to the [Clever repository](https://github.com/CopterExpress/clever).
Prepare your article and send it as a pull request to the [Clover repository](https://github.com/CopterExpress/clover).
1. Fork the Clever repository:
1. Fork the Clover repository:
<img src="../assets/github-fork.png" alt="GitHub Fork">
2. Check out the freshly-forked repository on your computer:
```bash
git clone https://github.com/<USERNAME>/clever.git
git clone https://github.com/<USERNAME>/clover.git
```
3. Open the directory with the source code checkout and create a new branch for your article (for example, `new-article`):
@@ -75,7 +75,7 @@ Prepare your article and send it as a pull request to the [Clever repository](ht
```bash
git add docs/
git commit -m "Add new article for Clever"
git commit -m "Add new article for Clover"
```
8. Upload your branch to your forked repository on GitHub:
@@ -84,7 +84,7 @@ Prepare your article and send it as a pull request to the [Clever repository](ht
git push -u origin new-article
```
9. Open your repository on GitHub and send a `pull request` from your branch to Clever:
9. Open your repository on GitHub and send a `pull request` from your branch to Clover:
<img src="../assets/github-pull-request.png" alt="GitHub Pull Request">