Skip to content

Latest commit

 

History

History
103 lines (70 loc) · 3.95 KB

File metadata and controls

103 lines (70 loc) · 3.95 KB

Contributing Guide

[TODO: Update the content of this document to match the needs of your project]

Welcome! We are glad that you want to contribute to our project! 💖

As you get started, you are in the best position to give us feedback on areas of our project that we need help with including:

  • Problems found during setting up a new developer environment
  • Gaps in our Quickstart Guide or documentation
  • Bugs in our automation scripts

If anything doesn't make sense, or doesn't work when you run it, please open a bug report and let us know!

Ways to Contribute

Instructions

We welcome many different types of contributions including:

  • New features
  • Builds, CI/CD
  • Bug fixes
  • Documentation
  • Issue Triage
  • Answering questions on Slack/Mailing List
  • Web design
  • Communications / Social Media / Blog Posts
  • Release management

Not everything happens through a GitHub pull request. Please come to our meetings or contact us and let's discuss how we can work together.

Come to Meetings

Instructions

Absolutely everyone is welcome to come to any of our meetings. You never need an invite to join us. In fact, we want you to join us, even if you don’t have anything you feel like you want to contribute. Just being there is enough!

You can find out more about our meetings here. You don’t have to turn on your video. The first time you come, introducing yourself is more than enough. Over time, we hope that you feel comfortable voicing your opinions, giving feedback on others’ ideas, and even sharing your own ideas, and experiences.

Find an Issue

Instructions

We have good first issues for new contributors and help wanted issues suitable for any contributor. good first issue has extra information to help you make your first contribution. help wanted are issues suitable for someone who isn't a core maintainer and is good to move onto after your first pull request.

Sometimes there won’t be any issues with these labels. That’s ok! There is likely still something for you to work on. If you want to contribute but you don’t know where to start or can't find a suitable issue, you can explain how people can ask for an issue to work on.

Once you see an issue that you'd like to work on, please post a comment saying that you want to work on it. Something like "I want to work on this" is fine.

Ask for Help

Instructions

The best way to reach us with a question when contributing is to ask on:

⚠️ Pick the way(s) that you prefer people ask for help

  • The original github issue
  • The developer mailing list
  • Our Slack channel

Pull Request Lifecycle

Instructions

  • Be patient. Your contributions are important, and we will do our best to review them in a timely manner.
  • Be responsive to feedback from maintainers.
  • Don't hesitate to seek help if needed.

Development Environment Setup

Instructions

Explain how to set up a development environment

Sign Your Commits

Instructions