mirror of
https://github.com/samschott/maestral.git
synced 2024-09-21 19:08:44 +03:00
[docs] include Contributing section and clean up structure
This commit is contained in:
parent
b44ae1bf4d
commit
dd3211cf90
@ -1,5 +1,5 @@
|
||||
|
||||
## Guidelines
|
||||
### Code
|
||||
|
||||
To start, install maestral with the `dev` extra to get all dependencies required for
|
||||
development:
|
||||
@ -8,7 +8,8 @@ development:
|
||||
pip3 install maestral[dev]
|
||||
```
|
||||
|
||||
### Checking the Format, Coding Style, and Type Hints
|
||||
This will install packages to check and enforce the code style, use pre-commit hooks and
|
||||
bump the current version.
|
||||
|
||||
Code is formatted with [black](https://github.com/psf/black).
|
||||
Coding style is checked with [flake8](http://flake8.pycqa.org).
|
||||
@ -23,7 +24,8 @@ pre-commit run -a
|
||||
```
|
||||
|
||||
You can also install the provided pre-commit hook to run checks on every commit. This
|
||||
will however significantly slow down commits.
|
||||
will however significantly slow down commits. An introduction to pre-commit commit hooks
|
||||
is given at [https://pre-commit.com](https://pre-commit.com).
|
||||
|
||||
### Documentation
|
||||
|
||||
@ -40,7 +42,7 @@ pip3 install maestral[docs]
|
||||
The API documentation is mostly based on doc strings. Inline comments should be used
|
||||
whenever code may be difficult to understand for others.
|
||||
|
||||
## Tests
|
||||
### Tests
|
||||
|
||||
The test suite uses a mixture of [unittest](https://docs.python.org/3.8/library/unittest.html)
|
||||
and [pytest](https://pytest-cov.readthedocs.io/en/latest/), depending on what is most
|
||||
|
15
docs/background/index.rst
Normal file
15
docs/background/index.rst
Normal file
@ -0,0 +1,15 @@
|
||||
|
||||
Background
|
||||
==========
|
||||
|
||||
This section introduces some of the design principles and functionality of the different
|
||||
modules, including the sync functionality and how index and state data is stored locally.
|
||||
|
||||
.. toctree::
|
||||
:caption: Contents
|
||||
:maxdepth: 1
|
||||
|
||||
sync_logic
|
||||
logging
|
||||
config_files
|
||||
state_files
|
7
docs/contributing.rst
Normal file
7
docs/contributing.rst
Normal file
@ -0,0 +1,7 @@
|
||||
|
||||
Contributing
|
||||
============
|
||||
|
||||
Thank you for your interest in contributing!
|
||||
|
||||
.. mdinclude:: ../CONTRIBUTING.md
|
@ -8,14 +8,12 @@ For a user manual and an overview of Maestral's functionality, please
|
||||
refer to the `wiki <https://github.com/SamSchott/maestral-dropbox/wiki>`_.
|
||||
|
||||
.. toctree::
|
||||
:caption: Table of Contents
|
||||
:maxdepth: 1
|
||||
:caption: Contents
|
||||
:maxdepth: 2
|
||||
|
||||
sync_logic
|
||||
logging
|
||||
config_files
|
||||
state_files
|
||||
background/index
|
||||
API Reference <autoapi/maestral/index>
|
||||
contributing
|
||||
|
||||
Getting started
|
||||
***************
|
||||
|
Loading…
Reference in New Issue
Block a user