CopterExpress/clover
1
0
Fork 0
mirror of https://github.com/CopterExpress/clover.git synced 2026-05-26 21:19:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Update contribution guidelines translation

Browse Source
This commit is contained in:
Alexey Rogachevskiy
2020-02-25 14:25:31 +03:00
parent ef0f926a79
commit a427d86f41
1 changed files with 60 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

71
docs/en/contributing.md
View File

@@ -6,19 +6,21 @@ Clever is mostly an [open source](https://en.wikipedia.org/wiki/Open-source_soft
## Markdown
All Clever documentation is written in the widespread [Markdown](https://ru.wikipedia.org/wiki/Markdown) format. There are many guides on it on the Internet.
All Clever 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/.
In English: https://www.markdownguide.org/getting-started, https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet.
For the ease of editing texts, you may use text editors with markdown support [Typora](https://typora.io), [Dillinger](https://dillinger.io/) (web), [VSCode](https://code.visualstudio.com) with the [Markdown Editor plugin](https://marketplace.visualstudio.com/items?itemName=MadsKristensen.MarkdownEditor).
For the ease of editing texts, you may use text editors with Markdown support: [Typora](https://typora.io), [Dillinger](https://dillinger.io/) (web), [VSCode](https://code.visualstudio.com) with the [Markdown Editor plugin](https://marketplace.visualstudio.com/items?itemName=MadsKristensen.MarkdownEditor).
We also recommend using the [Code Spell Checker](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) VScode plugin.
For a local build of a static documentation website, use the [`gitbook-cli`](https://github.com/GitbookIO/gitbook-cli) utility.
## Correcting errors in the documents
## Fixing documentation errors
If you have found an error in the documents, or if you want to improve it, use the Pull Request mechanism.
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.
2. Click "Edit".
@@ -32,14 +34,61 @@ If you have found an error in the documents, or if you want to improve it, use t
More information about Pull Requests is available [at GitHub](https://help.github.com/articles/about-pull-requests/) (English) or in [GIT documentation](https://git-scm.com/book/ru/v2/GitHub-contributing-to_projects) (Russian).
<!--
## Adding a new article
## Contributing a new article
TODO
-->
> **Note** If you've made your own project based on Clever, you can add an article about it to the "Clever-based projects" section.
## Your project with Clever
Prepare your article and send it as a pull request to the [Clever repository](https://github.com/CopterExpress/clever).
If you have implemented your own interesting project using clever, you can add an article about it in section "Clever-based projects".
1. Fork the Clever repository:
<!-- TODO -->
<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
```
3. Open the directory with the source code checkout and create a new branch for your article (for example, `new-article`):
```bash
git checkout -b new-article
```
4. Write a new article in the [Markdown](https://en.wikipedia.org/wiki/Markdown) format and save it in the `docs/ru` or `docs/en` folder (for example, `docs/en/new_article.md`).
5. Place additional visual assets in the `docs/assets` folder and add them to your article.
6. Add a link to your article to the appropriate section in the `SUMMARY.md` file (in the same folder as in the fourth step):
```markdown
...
* Supplementary materials
* [COEX Pix](coex_pix.md)
* [Contribution guidelines](contributing.md)
* [New article](new_article.md)
* [RC troubleshooting](radioerrors.md)
* [Flashing ESCs](esc_firmware.md)
...
```
7. Commit your changes locally:
```bash
git add docs/
git commit -m "Add new article for Clever"
```
8. Upload your branch to your forked repository on GitHub:
```bash
git push -u origin new-article
```
9. Open your repository on GitHub and send a `pull request` from your branch to Clever:
<img src="../assets/github-pull-request.png" alt="GitHub Pull Request">
<img src="../assets/github-pull-request-create.png" alt="GitHub Create Pull">
10. Wait for the review, be ready to make changes if needed.
11. Look at your new and useful article at https://clever.coex.tech !