Skip to content
Permalink
Browse files

Adding readme, code_of_Conduct, contributing guidelines

  • Loading branch information...
konark-cliqz committed May 29, 2017
1 parent c1526fc commit 0e726555dad4f4181c7ba5d5ed1feeb5f483ec72
Showing with 775 additions and 9 deletions.
  1. +46 −0 CODE_OF_CONDUCT.md
  2. +51 −0 CONTRIBUTING.md
  3. +660 −0 LICENSE.md
  4. +18 −9 README.md
@@ -0,0 +1,46 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [michel@cliqz.com](mailto:michel@cliqz.com). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

## Attribution

This Code of Conduct is taken from [Atom's code of conduct](https://github.com/atom/atom/blob/master/CODE_OF_CONDUCT.md) which was adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version].

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
@@ -0,0 +1,51 @@
# Contributing to 'Green Analytics'

Thank you for taking the time to contribute! We are excited to welcome contributors and we really value the time you take to work with us on this project.

*Green Analytics* is meant to provide solutions :

* Privacy first analytics.
* Privacy first social sharing features.


This documents is a set of guidelines for contributing to 'Green Analytics' on GitHub. These are guidelines, not rules. This guide is meant to make it easy for you to get involved.

* [Participation guidelines](#participation-guidelines)
* [What we're working on](#what-were-working-on)
* [How to submit changes](#how-to-submit-changes)
* [How to report bugs](#how-to-report-bugs)
* [Communication channels](#communication-channels)

## Participation guidelines

This project adheres to a [code of conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [michel@cliqz.com](mailto:michel@cliqz.com).

## What we're working on

The project is still at an early stage, which means there are a lot of opportunities to contribute in a meaningful way. To ease the onboarding process, we have gathered and created issues in our issue tracker. Please take a look at the [opened issues](https://github.com/cliqz-oss/green-analytics/issues).


## How to submit changes

Once you've identified one of the issues above that you feel you can contribute to, you're ready to make a change to the project repository!

1. **Notify others by commenting on the issue**. By commenting on the issue, you
will initiate a discussion around possible solutions and also communicate to
other contributors that you started working on it. This will avoid having
several people starting working on the same thing.
2. **[Fork](https://help.github.com/articles/fork-a-repo/) this repository**. This makes your own version of this project you can edit and use.
3. **[Make your changes](https://guides.github.com/activities/forking/#making-changes)**! You can do this in the GitHub interface on your own local machine (we *strongly recommend that you create a new branch* to make your changes). Once you're happy with your changes...
4. **Submit a [pull request](https://help.github.com/articles/proposing-changes-to-a-project-with-pull-requests/)**. This opens a discussion around your project and lets the project lead know you are proposing changes.

First time contributing to open source? Check out this *free* series, [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github).

## How to report bugs

Bugs are everywhere, and we would love it if you could be on the lookout for them, and raise an [issue](https://github.com/cliqz-oss/privacy-bot/issues) if you find one. Bugs can be anywhere:

* Conceptual design,
* Code,
* Spelling or formatting,
* or anything else we haven't yet thought of.

If you notice a bug, please raise an issue and label it with the label `bug`. Then anyone in community can get right on it, and everything gets fixed faster.

0 comments on commit 0e72655

Please sign in to comment.
You can’t perform that action at this time.