Merge pull request #34 from transifex/contribution

Update README

Author: Dimitrios Bendilas

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# 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, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, 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 support@transifex.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 adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

CONTRIBUTING.md

@@ -0,0 +1,64 @@
+# Contributing to Transifex Python Toolkit
+
+:tada: Thank you for your interest in contributing to this project! :tada:
+
+## Table Of Contents
+
+* [Code of Conduct](#code-of-conduct)
+* [I just have a question](#i-just-have-a-question)
+* [Contributor License Agreement](#contributor-license-agreement)
+* [How to Contribute](#how-to-contribute)
+  * [Reporting Bugs](#reporting-bugs)
+  * [Suggesting Improvements](#suggesting-improvements)
+  * [Creating Patches](#creating-patches)
+
+# Code of Conduct
+
+Please read this project's [Code of Conduct](/CODE_OF_CONDUCT.md) for the detailed standards on how to engage in this community.
+
+# I just have a question
+
+If you are not looking to contribute, but rather have a question about this project, you can visit the [Transifex Community](https://community.transifex.com/c/transifex-native) and ask there directly.
+
+# How to Contribute
+
+There are several ways to contribute to this project and they are all equally welcome. You can report a bug, suggest an improvement or submit an improvement yourself, be it a change in the code or in the documentation.
+
+## Reporting Bugs
+
+Bugs in this project are tracked as [GitHub issues](https://guides.github.com/features/issues/). Before submitting a new issue, make sure you check the [list of exiting issues](https://github.com/transifex/transifex-python/issues), as it might already be there.
+
+When creating an issue, make sure you include the following:
+* A clear and descriptive title.
+* The exact steps to allow others to reproduce the issue.
+* The behavior you observed and the reason you find this problematic.
+* The behavior you expected instead and the reason for this.
+* Any material that would better showcase the issue, such as screenshots or animated GIFs.
+* The version(s) of this library you have seen this erroneous behavior in
+* Make sure you DO NOT INCLUDE any sensitive information, such as a token, a secret or a private URL to a Transifex project or resource
+
+## Suggesting Improvements
+
+Improvement suggestions in this project are tracked as [GitHub issues](https://guides.github.com/features/issues/). Before submitting a new suggestion, make sure you check the [list of exiting issues](https://github.com/transifex/transifex-python/issues), as it might already be there.
+
+When creating an improvement issue, make sure you include the following:
+* A clear and descriptive title.
+* The exact steps to allow others to reproduce the issue.
+* The current behavior/functionality, what you would prefer to see instead and why.
+* An explanation on why this improvement would benefit most users of this library and not just your use case
+* Any material that could better showcase the current and the expected behavior, such as screenshots or animated GIFs.
+* Make sure you DO NOT INCLUDE any sensitive information, such as a token, a secret or a private URL to a Transifex project or resource
+
+## Creating Patches
+
+### Contributor License Agreement
+
+Before contributing with suggested changes, you must sign our [Contributor License Agreement](https://docs.transifex.com/legal/contributing).
+
+If you want to submit a patch that either fixes a bug or introduces a new feature, you need to have the following in mind:
+* The Pull Request (PR) handles one thing, i.e. fixes a certain bug or introduces a specific new functionality, instead of combining many at once.
+* Each commit should include one logical change each and should ideally be few in number per PR.
+* All [status checks](https://help.github.com/articles/about-status-checks), including the execution of the test suit, must pass.
+* The Rebase workflow is followed: each branch must be rebased over `origin/devel` before being allowed to get merged.
+
+In order for a PR to be merged, at least one maintainer of this project must first review and approve it. The reviewer(s) may request changes before moving on.

README.md

@@ -5,20 +5,22 @@
 
 Transifex Python Toolkit is a collection of tools that allow you to easily localize your Django and Python applications using Transifex. The toolkit features fetching translations over the air (OTA) to your apps.
 
+This project adheres to the Contributor Covenant [code of conduct](/CODE_OF_CONDUCT.md). To contribute to Transifex Python Toolkit, please check out the [contribution guidelines](/CONTRIBUTING.md).
+
 1. Install toolkit in your code `$ pip install transifex-python`
 2. Add a provided TOKEN and SECRET in your config, connecting your application with a Transifex project
 3. Add internationalization commands in your code
 ```HTML+Django
   <!-- Django app template example -->
-  
+
   {% load transifex %}
   <p>{% t "Hello!" %}</p>
   <p>{% t "I want to be translated." %}</p>
   ```
 
 ```python
   # Django view sample
-  from transifex.native.django import t	
+  from transifex.native.django import t
 
   output = {
       "msg1": t("Welcome aboard!"),
@@ -28,7 +30,7 @@ Transifex Python Toolkit is a collection of tools that allow you to easily local
   ```
 4. Push strings to your connected Transifex project `./manage.py transifex push`
 5. When translations are added in your Transifex project are automatically made available
-    
+
 To learn more about using Transifex Python toolkit check:
 * [Quickstart guide for Django web application](https://docs.transifex.com/django-sdk/quickstart-1?utm_campaign=tx-native&utm_source=github&utm_medium=link)
 * [Quickstart guide for Python application](https://docs.transifex.com/python-sdk/quickstart?utm_campaign=tx-native&utm_source=github&utm_medium=link)