Skip to content

Latest commit

 

History

History
94 lines (61 loc) · 4.49 KB

contributing.md

File metadata and controls

94 lines (61 loc) · 4.49 KB
Raw

Introduction

Welcome!

First off, thank you for considering contributing to this GitHub repo.

It's people like you that make this such a fantastic place to be!

Following these guidelines helps to communicate that you respect the time of the everyone learning, managing, and developing this open source project. In return, they should reciprocate that respect in addressing your questions, assessing changes, and helping you finalize your pull requests.

Community

I follow the general conventions and attitudes of the Python and Go communities. Both are very welcoming and social. If you want to connect to some of these groups, consider taking a look at the following:

Selected Python Community Resources

  • Python community
  • PyConUS website
  • Python Software Foundation (PSF) Code of Conduct
  • If you are in Austin, you may like the Austin Python Meetup
  • If you wish you were local ... PyTexas
  • For the data inspired: Beautiful Data Visualizations

Selected Go Community Resources

  • Go Community Code of Conduct
  • Rob Pike Simplicity
  • Francesc Campoy justforfunc: Programming in Go
  • If you are in Austin, you may like the Austin Go Language Meetup
  • For the data inspired: Go Developer Survey 2020

All we're looking for from you is kind and creative communication, suggestions, or fixes.

We're all here to learn, so let people know that they can do it! Let people know that they are welcome to be here too.

This is an open source project and I love to receive contributions from the community — you! There are many ways to contribute, so keep an open mind and think outside the box.

I'm only looking for positive and constructive ideas. If you have something negative to communicate, please leave that pretty much anywhere else. Images, messages, and ideas that communicate negativity will not be approved.

Ground Rules

Be positive, be welcoming.

Responsibilities

  • Ensure cross-platform compatibility for every change that's accepted. Windows, Mac, Debian & Ubuntu Linux.
  • Create issues for any major changes and enhancements that you wish to make. Discuss things transparently and get community feedback.
  • Don't add any classes to the codebase unless absolutely needed. Err on the side of using functions.
  • Keep feature versions as small as possible, preferably one new feature per version.
  • Be welcoming to newcomers and encourage diverse new contributors from all backgrounds. See the Python Community Code of Conduct for a better description of what I mean.

Help!

Not sure how you got here or how to get started?

Working on your first Pull Request? You can learn more from this free series, How to Contribute to an Open Source Project on GitHub.

Feel free to ask for help; everyone is a beginner at first

How to report a bug

If you find a security vulnerability, do NOT open an issue. Notify me personally, please.

If you decide to file an issue, make sure to use the templates for Bug Reports or Feature Requests as a guideline.

Just so you know

I look at Pull Requests on a regular basis. I'm doing this on my own, so it might take a little time before I get to every pull request, but I promise I will!

If feedback has been given, I expect responses within one month. After one month, I may close the pull request if it isn't showing any activity. Chances are, though, if you are submitting a simple note or image, your change will be merged without feedback. I'm just putting this here for the rare instance that I might need a little more information from you.

Thank You!

It is your participation that makes the community great.