Skip to content

Commit

Permalink
docs: adapt readme and add guidelines
Browse files Browse the repository at this point in the history
Besides extending the README, this adds basic contributing guidelines
and an initial code of conduct.
  • Loading branch information
smlng committed Nov 3, 2018
1 parent 67756be commit 4f79bb3
Show file tree
Hide file tree
Showing 5 changed files with 111 additions and 8 deletions.
68 changes: 68 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# 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.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project maintainer at <[email protected]>. 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.

## 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
16 changes: 16 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
## Contributing to PyCayenneLPP

As a free open source software project (FOSS), PyCayenneLPP welcomes
contributions of many forms. Essentially it comes down to either open
an Issue or Pull Request on Github. Issues are used (but not limited)
to report bugs, make feature requests, or ask questions. In the same
way Pull Request are used (but not limited) to provide patches, make
improvements to documentation, or add tests.

To ensure and maintain code quality and robustness pull requests must
pass Travis CI before being merged into master.

## Code of conduct

Please note that this project is released with a Contributor Code of Conduct.
By participating in this project you agree to abide by its terms.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# PyCayenneLPP

A Cayenne Low Power Payload (CayenneLPP) decoder and encoder for Python.
This is a free open source software project published under the permissive
[MIT License](LICENSE).

Please take note of the [contributing guidelines](CONTRIBUTING.md) and the
[Code of Conduct](CODE_OF_CONDUCT.md).

## Requirements

PyCayenneLPP does not have any external dependencies and only uses builtin
functions and types of Python 3. It requires at least Python in version 3.4.
The PyCayenneLPP package is available via PyPi using `pip`. To install it run:

```
pip3 install pycayennelpp
```

## Usage

Simply add this import to your application to utilise PyCayenneLPP:

```
import cayennelpp
```
7 changes: 0 additions & 7 deletions README.rst

This file was deleted.

2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@


def readme():
with open('README.rst') as f:
with open('README.md') as f:
return f.read()


Expand Down

0 comments on commit 4f79bb3

Please sign in to comment.