Skip to content

CONTRIBUTING.rst

Latest commit

 

History

History
92 lines (68 loc) · 3.17 KB

CONTRIBUTING.rst

File metadata and controls

92 lines (68 loc) · 3.17 KB

Thank you for your interest in SearXNG.

Have a look at our Quickstart guide, it's very easy to contribute.

Further information on how-to can be found here.

Translations

Help translate SearXNG at Weblate.

Weblate

Cloud development

You can contribute from your browser using GitHub Codespaces:

  • Fork the repository.
  • Click on the <> Code green button.
  • Click on the Codespaces tab instead of Local.
  • Click on Create codespace on master.
  • VSCode is going to start in the browser.
  • Wait for git pull && make install to appear and then disappear.
  • You have 120 hours per month (see also your list of existing Codespaces).
  • You can start SearXNG using make run in the terminal or by pressing Ctrl+Shift+B.

How-to contribute

Submitting pull requests

Please follow the provided PR template when writing a description for your changes.

Do not take criticism personally. When you get feedback, it is about your work, not your character or personality. Keep in mind we all want to make SearXNG better.

When something is not clear, please ask questions to clear things up.

If you would like to introduce a big architectural change or do a refactor, either in the codebase or the development tooling, please open an issue with a proposal first. This way we can think together about the problem and probably come up with a better solution.

Coding conventions and guidelines

Commit messages

  • Always write descriptive commit messages ("fix bug" is not acceptable).
  • Use the present tense ("Add feature", not "Added feature").
  • Use the imperative mood ("Move cursor to...", not "Moves cursor to...").
  • Limit the first line (commit title) to 72 characters or less.

See Commits guide for more details.

Coding guidelines

As a Python project, we must follow PEP 8 and PEP 20 guidelines.

Furthermore, follow Clean Code conventions. The most important rules in this project are:

  • Simpler is better. KISS principle
  • Be consistent.
  • Every function must do one thing.
  • Use descriptive names for functions and variables.
  • Always look for the root cause.
  • Keep configurable data high level.
  • Avoid negative conditionals.
  • Prefer fewer arguments.
  • Do not add obvious comments to code.
  • Do not comment out code, delete lines instead.