mirror of
https://github.com/aljazceru/python-teos.git
synced 2025-12-18 14:44:21 +01:00
61 lines
2.1 KiB
Markdown
61 lines
2.1 KiB
Markdown
# Contributing to the Eye of Satoshi
|
|
|
|
The following is a set of guidelines for contributing to TEOS.
|
|
|
|
## Code Style Guidelines
|
|
We use [black](https://github.com/psf/black) as our base code formatter with a line length of 120 chars. Before submitting a PR make sure you have properly formatted your code by running:
|
|
|
|
```bash
|
|
black --line-length=120 {source_file_or_directory}
|
|
```
|
|
On top of that, there are a few rules to also have in mind.
|
|
|
|
### Code Spacing
|
|
Blocks of code should be created to separate logical sections
|
|
|
|
```python
|
|
responder = Responder(db_manager)
|
|
responder.jobs, responder.tx_job_map = Builder.build_jobs(responder_jobs_data)
|
|
|
|
watcher.responder = responder
|
|
watcher.appointments, watcher.locator_uuid_map = Builder.build_appointments(watcher_appointments_data)
|
|
```
|
|
We favour spacing between blocks like `if/else`, `try/except`, etc.
|
|
|
|
```python
|
|
if tx in missed_confirmations:
|
|
missed_confirmations[tx] += 1
|
|
|
|
else:
|
|
missed_confirmations[tx] = 1
|
|
```
|
|
|
|
An exception to the rule are nested `if` statements that placed right after each other and `if` statements with a single line of code.
|
|
|
|
```python
|
|
for opt, arg in opts:
|
|
if opt in ["-s", "server"]:
|
|
if arg:
|
|
teos_api_server = arg
|
|
```
|
|
|
|
```python
|
|
if rcode == 0:
|
|
rcode, message = self.check_start_time(start_time, block_height)
|
|
if rcode == 0:
|
|
rcode, message = self.check_end_time(end_time, start_time, block_height)
|
|
```
|
|
|
|
## Dev requirements
|
|
In order to contrubite you will need to install additional dependencies. They can be found at `requirements-dev.txt`. Install them by running:
|
|
|
|
pip install -r requirements-dev.txt
|
|
|
|
## Code Documentation
|
|
Code should be, at least, documented using docstrings. We use the [Sphinx Google Style](https://www.sphinx-doc.org/en/master/usage/extensions/example_google.html#example-google) for documenting functions.
|
|
|
|
## Test Coverage
|
|
We use [pytest](https://docs.pytest.org/en/latest/) to build and run tests. Tests should be provided to cover both positive and negative conditions. Test should cover both the proper execution as well as all the covered error paths. PR with no proper test coverage will be rejected.
|
|
|
|
|