Skip to content

Latest commit

 

History

History
81 lines (56 loc) · 2.19 KB

CONTRIBUTING.md

File metadata and controls

81 lines (56 loc) · 2.19 KB

Project: pybricks-api

Acceptable changes:

  • Fixing typos, spelling, grammar, etc.
  • Clarifying existing documentation.
  • Improving code completion/intellisense.

Other more substantial changes should be discussed first by opening an issue on GitHub. Proposals for new APIs should be discussed in the pybricks-micropython repository since that is where the new features will actually be implemented.

Commit messages:

  • Commit messages have a one-line subject, a blank line and a multiline body:

      prefix: subject

  body...

  • Use a prefix to categorize the change. Usually this is the path the the file being changed.

    • If it is a documentation change, it can be shortened to doc/<file> (omit api from the path).
    • If it is an API change (in the pybricks folder), write api/<file> instead of pybricks/<file>.

  • The subject briefly describes what was changed, e.g. fix typo.

  • The body describes why the change was made, e.g. The word "sensor" was spelled incorrectly.

  • See the commit history for more examples.

Development environment:

Prerequisites:

Information on installing prerequisites can be found on the pybricks-micropython wiki.

Initial setup:

git clone --recursive https://github.com/pybricks/pybricks-api
cd pybricks-api
poetry install

Build docs:

# Linux
poetry run make -C doc html
xdg-open doc/api/build/html/index.html

# macOS
poetry run make -C doc html
open doc/api/build/html/index.html

# Windows (PowerShell)
poetry run doc\make.bat html
Invoke-Item doc\api\build\html\index.html

Linting:

poetry run flake8  # check Python
poetry run doc8  # check Restructured Text