Skip to content

Latest commit

 

History

History
35 lines (22 loc) · 1.87 KB

CONTRIBUTING.md

File metadata and controls

35 lines (22 loc) · 1.87 KB

This repo has plugins for sadevbot of the San Antonio Devs slack.

Contributions here are mostly driven by community members, but all PRs and participation that follow our rules https://sanantoniodevs.com/pages/rules.html is welcome!

What is this anyway?

This repo contains plugins for errbot. You could make your own repo if you wanted, or create a new plugin here. Honestly, its a single repo just to make my life easier :D

What's errbot?

https://errbot.readthedocs.io/en/master/index.html

How do I write an errbot plugin

Create a new folder with the name of your plugin then follow https://errbot.readthedocs.io/en/latest/user_guide/plugin_development/ to develop your plugin.

Git Workflow

Fork the repo, do your work in your repo, then PR your changes back to the SADevs repo.

Commit Messages

Follow the guide here and make your commit messages meaningful. Commit subject lines should be less than 72 characters long and the body less than 80 characters.

Unit tests/CI

Unit tests go in tests/. Install test-requirements.txt and then run tests with "pytest"

Commit Linting

This repo uses convenctional commits. Check out https://www.conventionalcommits.org/en/v1.0.0/ for more info on how to use conventional commits.

I have an idea for a plugin

AWESOME! Reach out to the admins (or just @drlordrevandrew) to discuss it. As long as there's no glaring issues (someone else working on something similar, conflict of interest, or a violation of our rules) we'll give you the greenlight you can get started!

I don't have an idea but I'd like to write a plugin or contribute

Still awesome. Check out issues for plugin ideas or reach out to the admins for ideas

Where can I learn more/ask questions/talk about this

"#errbot" on the sadevs slack