Skip to content

CONTRIBUTING.rst

Latest commit

 

History

History
106 lines (70 loc) · 3.1 KB

CONTRIBUTING.rst

File metadata and controls

106 lines (70 loc) · 3.1 KB

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/thomwiggers/onebot/issues.

If you are reporting a bug running an instance, please include:

  • Your operating system name and version.
  • Python version and versions of dependencies (pip freeze output)
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

If you are reporting a bug using an IRC plugin or command, include the output.

Fix Bugs

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

Implement Features

Look through the GitHub issues for features. Anything tagged with "feature" is open to whoever wants to implement it.

Write Documentation

OneBot could always use more documentation, whether as part of the official OneBot docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/thomwiggers/onebot/issues.

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!

Ready to contribute? Here's how to set up onebot for local development.

  1. Fork the onebot repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:your_name_here/onebot.git

  3. Install your local copy into a virtualenv. We use uv for dependency management:

    $ cd onebot/
$ uv sync

    This will create a virtual environment and install all dependencies.

  4. Create a branch for local development:

    $ git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  5. When you're done making changes, check that your changes pass ruff formatting and the tests, including testing other Python versions with tox:

    $ uv run ruff format .
$ uv run tox

  6. Commit your changes and push your branch to GitHub:

    $ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

  7. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
  3. The pull request should work for Python 3.11+. Check https://github.com/thomwiggers/onebot/actions and make sure that the tests pass for all supported Python versions.
  4. Don't forget to add yourself to AUTHORS.rst!