Skip to content

Latest commit

 

History

History
41 lines (25 loc) · 2.67 KB

CONTRIBUTING-basho-labs.md

File metadata and controls

41 lines (25 loc) · 2.67 KB
Raw

#Notes Below is a default CONTRIBUTING.md file for all repositories under the Basho Labs organization. It's best to keep the Contributing header identical - please open a PR if you think it should change!

All How-to contribute sections are recommended to be updated with the maintainer's preferred text.

##Contributing

This repository is community supported. We both appreciate and need your contribution to keep it stable.

Every community supported project at Basho has a maintainer. $USERNAME is the maintainer here. For more on how to contribute, take a look at the contribution process.

Thank you for being part of the community! We love you for it.

How-to contribute

How-to contribute to the .NET client

Basho Labs repos survive because of community contribution. Here’s how to get started.

IMPORTANT: This is an open source project licensed under the Apache 2.0 License. We encourage contributions to the project from the community. We ask that you keep in mind these considerations when planning your contribution.

  • Whether your contribution is for a bug fix or a feature request, create an [Issue](https://github.com/basho/LINK TODO LINK/issues) and let us know what you are thinking.
  • For bugs, if you have already found a fix, feel free to submit a Pull Request referencing the Issue you created.
  • For feature requests, we want to improve upon the library incrementally which means small changes at a time. In order ensure your PR can be reviewed in a timely manner, please keep PRs small, e.g. <10 files and <500 lines changed. If you think this is unrealistic, then mention that within the Issue and we can discuss it.

Once you're ready to contribute code back to this repo, start with these steps:

  • Fork the appropriate sub-projects that are affected by your change
  • Create a topic branch for your change and checkout that branch git checkout -b some-topic-branch
  • Make your changes and run the test suite if one is provided (see below)
  • Commit your changes and push them to your fork
  • Open a pull request for the appropriate project
  • Contributors will review your pull request, suggest changes, and merge it when it’s ready and/or offer feedback
  • To report a bug or issue, please open a new issue against this repository

You can read the full guidelines for bug reporting and code contributions on the Riak Docs.

And thank you! Your contribution is incredibly important to us. It'd be great for you to add it to a current or past community release note here.