Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
67 lines (47 loc) · 1.82 KB

CONTRIBUTING.md

File metadata and controls

67 lines (47 loc) · 1.82 KB

Contributing

Hey there! Want to help make Seekers API even more amazing? That's cool! Here's some information you should know before getting started:

Creating an issue

If you want to open an issue, please use the bug report template if something is not working or the feature request if you have a cool idea you think we should.

Creating a pull request

For creating a pull request, please fork and then clone this project. Make and test your changes, then create a pull request using the pull request template.

Build the project yourself

After that, install all requirements. Seekers API requires Python 3 and the following python packages for the build:

  • mypy-protobuf
  • grpclib
  • grpcio-tools
  • protobuf

For installing the requirements, we recommend setting up a virtual environment (e.g. venv). You can install the requirements with:

pip install mypy-protobuf grpclib grpcio-tools protobuf

To build the gRPC files, run the following command:

mkdir -p build/
python \
-m grpc_tools.protoc \
--python_out=build \
--grpc_python_out=build \
--proto_path=./ \
--plugin=protoc-gen-mypy="$(which protoc-gen-mypy)" \
--mypy_out=build \
--experimental_allow_proto3_optional \
seekers/api/*.proto

Alternatively, you can use Nix to both get the dependencies and build the project. If you are using stable Nix:

nix-build

If you are using Nix flakes:

nix build

And that's it!

Commit messages

Write your commit messages in English only! Please use Conventional Commits. Your commit messages should follow this structure:

  • feat: add your cool new feature
  • fix: fix a bug
  • docs: add or improve documentation
  • style: reformat code (no logic changes)