Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
101 lines (65 loc) · 2.7 KB

CONTRIBUTING.md

File metadata and controls

101 lines (65 loc) · 2.7 KB
Raw

Contributing

Contributions are welcome!

Types of Contributions

Report Bugs

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.

Write Documentation

You can never have enough documentation! Please feel free to contribute to any part of the documentation, such as the official docs, docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started with development

  1. You need:
  • Git
  • Python
  • Poetry
  • Likely, Linux or macOS, possibly flavours like virtual machines, WSL, Docker (it should work on Windows too, but I have neither time, nor will to support it).

  1. Fork https://github.com/marco-brandizi/brandizpyes.git

  2. git clone https://github.com/<your-username-or-organization>/brandizpyes.git and cd into it.

  3. Use poetry:

    $ poetry install
<Changes>
$ poetry pytest [test files/functions]

  4. Commit, push, and eventually send a pull request.

Best Practices

Please, try to follow these best practices.

Software engineering

Git and versioning

Pull Requests

  • Add tests to cover changes or new features
  • Use enough comments and documentation
  • Before creating a PR, merge your fork with the latest main branch and ensure it passes all the tests and builds.

Code of Conduct

Yeah, I have a doc for this too, which essentially, says be a decent person.