Skip to content

Latest commit

 

History

History
41 lines (25 loc) · 1.57 KB

CONTRIBUTING.md

File metadata and controls

41 lines (25 loc) · 1.57 KB
Raw

Contributing to Pbui Project

Thanks for considering to contribute to Pbui Project! We accept all kinds of contributions, including, but not limited to:

  • Reporting a bug
  • Discussing the current state of the code
  • Proposing new features
  • Submitting a bug fix or new feature

Discussion and Reporting

For cases of reporting bugs, discussing project state, or just asking general questions, you have two options:

  1. Reach out in the maintainer channel #pbui on Libera

  2. Create an issue on this repository. Please give as much detail as you can, especially when reporting bugs.

Of course, before creating issues, search for your question or bug to see if the topic has already been discussed.

Pull Requests

To submit a bug fix or new feature, create a pull request to the master branch of this repository. When you go to create your pull request, you will see a PR template to populate - please fill this out with as much detail as you can to the best of your ability. Here's what you need to do:

  1. Fork this repository
  2. Make changes to your fork of the repository
  3. Ensure your changes are working properly (adding/updating tests is a huge plus)
  4. Create a pull request

Testing

At the moment, we are working towards a full-coverage test suite. It would be much appreciated if you could include or update tests as you request changes to the repository!

Thanks for the help!

alt