venenux/CONTRIBUTING.md

2.1 KiB

Contributing to

We've put together the following guidelines to help you figure out where you can best be helpful.

Table of Contents

  1. Ground rules & expectations
  2. How to contribute
  3. Style guide
  4. Setting up your environment
  5. Contribution review process
  6. 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.
  • Please be adware of Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.
  • When adding content, please consider if it 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

  • Please perform a issue search before made any kind of contribution.
  • Please read minimal information about the git workflow before made contributions.

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, open a pull request.
  • If your contribution is major, such as a new guide or a translation, start by opening an issue first. That way, other people can weigh in on the discussion before you do any work.

Setting up your environment

TODO (gambas, lighty, geany, codeigniter)

Contribution review process

This repo is currently maintained by @mckaygerhard

Community

Please use the venenuxsarisari mail forum at googlegroups.

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.