Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
113 lines (81 loc) · 3.29 KB

CONTRIBUTING.md

File metadata and controls

113 lines (81 loc) · 3.29 KB

Contributing to synology-api

First things first many thanks for contributing! I know it is not easy to spend free time to contribute to a passion!

the VERY little guideline written in here would be just the basis on how to contribute to this package. As I say the following are just "guidelines" so do not feel obligated.

Just behave

Have a look on our Code of conduct!

How setup your environment

If you want to contribute to this package, you may want to setup your environment.

Install dependencies for your OS:

# macos
bash scripts/dependencies_darwin.sh

# linux
bash scripts/dependencies_linux.sh

Install right version of tools

asdf install

From now you can use Taskfile to run repetitive commands, for example:

task docs

To see all available tasks, run:

task --list

Install Python dependencies

To install Python dependencies, you can use the task command:

task install-python-deps

This will install all the required Python packages listed in requirements.txt and requirements-dev.txt using pip on your local machine.

Setup virtual environment

You can use venv to create a virtual environment for this project. We already have task for that, so you can run:

task venv

Formating code

In task file is defined a task to format the code, you can run it with:

task format

Currently task will run shellcheck and shfmt on shell scripts. In near future it will run formatters on python files.

pre-commit hooks

To ensure your code is properly formatted and passes all checks, we use pre-commit hooks. These hooks are installed automatically with the task install command (requires a Taskfile). If you prefer, you can install them manually with:

pre-commit install

Hooks will run automatically before each commit, but you can also trigger them manually:

pre-commit run --all-files
# or
task pre-commit

These pre-commit hooks help keep the codebase clean and consistent by checking formatting, linting, and running tests. They may seem strict at first, but they save time and reduce issues in the long run.

Validation

To ensure your code is valid and follows the project's standards, we use numpydoc for validation of docstrings.

To validate your code, you can run:

task numpydoc-validation

Alternatively, before committing, pre-commit hooks will automatically run this validation for the files you commit.

Testing

We would appreciate if you test your code on your Synology NAS (if you own one), this would save us plenty time before merging any of your pull request, It does not mean that we will not test it before but makes process lot easier, less open pull requests which means less hassle and review.

Pull Request

Check if there is an active branch in progress and Always make sure you are pulling into the right branch. Before creating a PR make sure to do not change setup, License and any other non code related file. Changing them would only slow down the process with consequently need of modifying the PR

We want you

We need volunteers so you may be the one! If you contribute we will become many which means, for me, this package will become even better. Do not be scared or shy to make a pull request and/or let us how we may improve this wrapper.