Skip to content

Latest commit

 

History

History
44 lines (35 loc) · 1.97 KB

CONTRIBUTING.md

File metadata and controls

44 lines (35 loc) · 1.97 KB
Raw

How to contribute

Before implementing your ideas, it is recommended first to create a corresponding issue and discuss the plan to be approved;) Also consider first to help with issues marked with help_needed label ;)

  1. Add a "feature request" Issue to this project.
  2. Discuss its need and possible implementation. And once approved...
  3. Fork the project.
  4. Clone your fork of the project git clone https://github.com/[my-github-username]/selene.git
  5. Install poetry via pip install poetry
  6. cd selene
  7. poetry install
  8. poetry shell
  9. Create your feature branch (git checkout -b my-new-feature)
  10. Commit your changes (git commit -am 'Add some feature')
  11. Push to the branch (git push origin my-new-feature)
  12. Create a new Pull Request

Code Conventions

We follow the principles of consistency and readability. Code-style is controlled by few linter jobs in GitHub Actions.

  1. Pycodestyle
  2. Pylint
  3. Black

Pycodestyle

  • protects the code from violations of agreed rules.
  • ignores E402,E731 rules for now.

Pycodestyle-full-report

  • prints a full report of pycodestyle rule violations, including not agreed yet.

Pylint

  • protects the code from violations of agreed rules.
  • lints all agreed rules configured in .pylintrc.
  • ignores list of rules which are not agreed yet .pylint-disabled-rules.

Pylint-full-report

  • lints all agreed rules configured in .pylintrc
  • prints a full report of pylint rule violations, including not agreed yet.

Black

  • lints default black rules except "string normalization".