Skip to content
This repository was archived by the owner on Jan 30, 2023. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@

root = true

[*]
insert_final_newline = true

[*.{js,py}]
charset = utf-8

[*.py]
indent_style = space
indent_size = 4

# Matches the exact files either package.json or .travis.yml
[*.{json,yml}]
indent_style = space
indent_size = 2
Binary file modified .gitignore
Binary file not shown.
24 changes: 24 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
Change Log
==========

Unreleased Changes
------------------


0.1.0 (2015-02-21)
------------------

### CHANGED

- **[license](LICENSE)** from **MIT** to **Apache 2.0**
- default virtualenv from `env` to `.env`
- `.gitignore` to cover more of the possible files encountered during development.


0.0.0 (2015-02-17)
------------------

### ADDED

- cookiecutter template from jacebrowning/template-python
- **MIT** [license](LICENSE.txt)
7 changes: 0 additions & 7 deletions CHANGES.md

This file was deleted.

66 changes: 66 additions & 0 deletions CLA.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
Mail Manager Python Interface
=============================

Contributor License Agreement:
------------------------------

Thank you for your interest in the Mail Manager Python Interface open source project being
administered by Kyle Chamberlin, Inc. The form of license below is a document that
clarifies the terms under which You, the person listed below, may contribute
software, bug fixes, configuration changes, documentation, or any other
materials that you send to us related to the Project (each a “Contribution”) to
the project. We appreciate your participation in our project, and your help in
improving the project, so we want you to understand what will be done with the
Contributions. This license is for your protection as well as the protection of
Kyle Chamberlin and its licensees; it does not change your rights to use your own
Contributions for any other purpose. Please complete the following information
about you and the Contributions and sign electronically by filling out the form
below.

If you have questions about these terms, please contact me at
kylechamberlin@project20million.org.

### Corporate Contributions:

If you are employed as a software engineer, or if your
employer is in the business of developing software, or otherwise may claim
rights in the Contributions, please provide information about your employer’s
policy on contributing to open source projects, including the name of the
supervisor to contact in connection with such contributions.

### You and Kyle Chamberlin agree:
- You grant us the ability to use the Contributions in any
way. You hereby grant to Kyle Chamberlin, a non-exclusive, irrevocable, worldwide,
royalty-free, sublicenseable, transferable license under all of Your relevant
intellectual property rights (including copyright, patent, and any other
rights), to use, copy, prepare derivative works of, distribute and publicly
perform and display the Contributions on any licensing terms, including without
limitation: (a) open source licenses like the MIT License, GNU General Public
License (GPL), the GNU Lesser General Public License (LGPL), the Common Public
License, or the Berkeley Software Distribution license (BSD); and (b) binary,
proprietary, or commercial licenses. Except for the licenses granted herein,
You reserve all right, title, and interest in and to the Contribution.
- You are able to grant us these rights. You represent that You are legally entitled to
grant the above license. If Your employer has rights to intellectual property
that You create, You represent that You have received permission to make the
Contributions on behalf of that employer, or that Your employer has waived such
rights for the Contributions.
- The Contributions are your original work. You
represent that the Contributions are Your original works of authorship, and to
Your knowledge, no other person claims, or has the right to claim, any right in
any invention or patent related to the Contributions. You also represent that
You are not legally obligated, whether by entering into an agreement or
otherwise, in any way that conflicts with the terms of this license. For
example, if you have signed an agreement requiring you to assign the
intellectual property rights in the Contributions to an employer or customer,
that would conflict with the terms of this license.
- We determine the code that
is in our project. You understand that the decision to include the Contribution
in any project or source repository is entirely that of Kyle Chamberlin, and this
agreement does not guarantee that the Contributions will be included in any
product.
- No Implied Warranties. Kyle Chamberlin acknowledges that, except as explicitly
described in this Agreement, the Contribution is provided on an “AS IS” BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED,
INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE,
NON-INFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
80 changes: 80 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
# How to contribute

Third-party patches are an essential part of open source software. We want
to keep it as easy as possible to contribute changes that get things working.
There are a few guidelines that we need contributors to follow so that we can
have a chance of keeping on top of things.

## Getting Started

* Make sure you have a [GitHub account](https://github.com/signup/free)
* Submit an issue on GitHub, assuming one does not already exist.
* Clearly describe the issue including steps to reproduce when it is a bug.
* Make sure you fill in the earliest version that you know has the issue.
* Fork the repository on GitHub

## Making Changes

* Create a topic branch from where you want to base your work.
* This is usually the master branch.
* Only target release branches if you are certain your fix must be on that
branch.
* To quickly create a topic branch based on master; `git checkout -b
fix/master/my_contribution master`. Please avoid working directly on the
`master` branch.
* Make commits of logical units.
* Check for unnecessary whitespace with `git diff --check` before committing.
* Make sure your commit messages are in the proper format.

````
(ISSUE NUMBER) Title of the bug being fixed.

Without this patch applied the bug persists. This is a problem because the
contributor is left to imagine what the commit message should look like
based on a description rather than an example. This patch fixes the
problem by making the example concrete and imperative.

The first line should be a real life issue number from the GitHub issue tracker.
The body describes the behaviour without the patch, why this is a problem, and
how the patch fixes the problem when applied.
````

* Make sure you have added the necessary tests for your changes.
* Run _all_ the tests to assure nothing else was accidentally broken.

## Making Trivial Changes

### Documentation

For changes of a trivial nature to comments and documentation, it is not
always necessary to create a new issue on GitHub. In this case, it is
appropriate to start the first line of a commit with '(doc)' instead of
an issue number.

````
(doc) Add typo/documentation commit example to CONTRIBUTING

There is no example for contributing a documentation commit
to the Puppet repository. This is a problem because the contributor
is left to assume how a commit of this nature may appear.

The first line is a real life imperative statement with '(doc)' in
place of what would have been the ticket number in a
non-documentation related commit. The body describes the nature of
the new documentation or comments added.
````

## Submitting Changes

* Sign the [Contributor License Agreement](https://www.clahub.com/agreements/KyleChamberlin/mail-manager-python-interface).
* Push your changes to a topic branch in your fork of the repository.
* Submit a pull request to the repository in the organization.
* The core team looks at Pull Requests on a regular basis.
* After feedback has been given we expect responses within two weeks. After two
weeks will may close the pull request if it isn't showing any activity.

# Additional Resources

* [Contributor License Agreement](https://www.clahub.com/agreements/KyleChamberlin/mail-manager-python-interface)
* [General GitHub documentation](http://help.github.com/)
* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)
Loading