Skip to content

Latest commit

 

History

History
53 lines (38 loc) · 1.94 KB

CONTRIBUTING.md

File metadata and controls

53 lines (38 loc) · 1.94 KB

Contributing to basicbots


First, thank you for contributing to basicbots. Without your support and help, this project couldn't exist.

Table of contents.

  1. Code of Conduct
  2. Roadmap
  3. What should I know before I get started?
  4. How Can I Contribute?
  5. Style Guides

Roadmap

  • Current roadmap is a combination of bugs, enhancements and longterm goals.

What should I know before I get started?

  • This is all about having fun. If it isn't fun, why are we doing it?

How Can I Contribute?

  • Coding conventions
  • Reporting bugs
  • Suggesting Enhancements
  • Your First Code Contribution
  • Pull Requests

Style Guides


Code of Conduct

This project and everyone participating in it is governed by the basicbots Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

TO DO

Coding conventions

  • Start reading our code and you'll get the hang of it. We optimize for readability.
  • This is open-source software. Consider the people who will read your code, and make it look nice for them. It's sort of like driving a car: Perhaps you love doing donuts when you're alone, but with passengers, the goal is to make the ride as smooth as possible.
  • use gofmt & vet on all source files before pushing. There should not be any errors or warnings.
  • use an editor that will automatically perform the gofmt and lint for you. I suggest VSCode with the go extensions.