Skip to content

Latest commit

 

History

History
43 lines (26 loc) · 2.74 KB

CONTRIBUTING.md

File metadata and controls

43 lines (26 loc) · 2.74 KB
Raw
layout
default

Contributing to TolaData

Thanks for checking out TolaData. TolaData is an open source project currently maintained by OpenBuild, MercyCorps and Humanitec.

Table of Contents

  1. Ground rules & expectations
  2. How to contribute
  3. Contribution review process
  4. Community

Ground rules & expectations

Before we get started, here are a few things we expect from you (and that you should expect from others):

  • Be kind and thoughtful in your conversations around this project. We all come from different backgrounds and projects, which means we likely have different perspectives on "how open source is done." Try to listen to others rather than convince them that your way is correct.
  • TolaData Community Versions are released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.
  • If you open a pull request, please ensure that your contribution passes all tests. If there are test failures, you will need to address them before we can merge your contribution.
  • When adding content, please consider if is widely valuable. Please don't add references or links to things you or your employer have created as others will do so if they appreciate it.

How to contribute

If you'd like to contribute, start by searching through the issues and pull requests to see whether someone else has raised a similar idea or question.

If you don't see your idea listed, and you think it fits into the goals of this guide, do one of the following:

  • If your contribution is minor, such as a typo fix, or self-contained, such as writing a translation, open a pull request.
  • If your contribution is major, such as a new functionality, start by opening an issue first. That way, other people can weigh in on the discussion before you do any work.

Contribution review process

This repo is currently maintained by @glind and @mahmoodkhan, who have commit access. They will likely review your contribution in the form of a pull request. If you haven't heard from anyone in 10 days, feel free to bump the thread or @-mention a maintainer to review your contribution.

Community

Discussions about TolaActivity, TolaTables and TolaWork take place in the Issues sections for each repo, TolaWork Issues as well as http://toladata.slack.com. Anybody is welcome to join these conversations.

Wherever possible, do not take these conversations to private channels, including contacting the maintainers directly. Keeping communication public means everybody can benefit and learn from the conversation.