Skip to content
This repository has been archived by the owner on Jul 16, 2024. It is now read-only.

Commit

Permalink
Added CoC, Update README & CONTRIBUTING
Browse files Browse the repository at this point in the history
Signed-off-by: James.E.Bell <james.e.bell@target.com>
  • Loading branch information
James.E.Bell committed Oct 19, 2017
1 parent bc7b406 commit c757f47
Show file tree
Hide file tree
Showing 3 changed files with 104 additions and 30 deletions.
74 changes: 74 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to make 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
[james.e.bell@target.com](mailto:james.e.bell@target.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
22 changes: 22 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,5 +35,27 @@ as clean as possible. Here is the basic workflow:
item of work for you to review. Additionally if changes
need to be made, _please_ let us know! We want to make
GREASE as awesome as possible!
2. Maintainers will Maintain
* As a maintainer, you're expected to help the
community out!
* We want to ensure contributors feel the speed at which
we pride ourselves in. Maintainers are expected:
* To triage any new PR within 24 hours of submission
* If review is requested/required: Completed in 96 hours
of submission
* If there are large merge conflicts (more than 5 files)
work with the contributor if they request it to resolve
the conflicts
3. You are responsible for your PR
* Filing a PR to GREASE is exciting! Make sure to take
ownership of the process to ensure speedy processing
* Maintainers are busy and it is our responsibility to respond.
We do though ask you to respond quickly when we ask for changes,
make comments or ask questions. We will respond by our time line
from the previous point, But we will expect you to interact back
if required

[_be sure to checkout the code of conduct as well_](https://github.com/target/grease/blob/master/.github/CODE_OF_CONDUCT.md)


## _Thanks!_
38 changes: 8 additions & 30 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,33 +46,11 @@ to Django, you write your application, GREASE just serves it.
## Installation & Requirements

### Requirements
1. PostgreSQL 9.4+
* Provision the database with the `database.sql` file
included here.
2. Python2.7
3. Pip
* Requests
* Psycopg2
* PyMongo

### Installation
1. Setup Your Environment Variables
* `GREASE_DSN` is the only one required at this point
2. Install GREASE
* `python setup.py install`
3. Register with your database
* `grease enterprise bridge register`
4. Next Steps
* Develop your module for GREASE Commands and Configurations
* Setup your environment for this package:
* `GREASE_CONF_PKG`: Your configuration Package
* `GREASE_CONF_DIR`: The directory in your package for
configurations to be loaded from
* `GREASE_SOURCES_PKG`: The package to load sources from
* if you plan to enable MongoDB for source de-duplication you'll
need some additional variables set:
* `GREASE_MONGO_HOST`: MongoDB Host Name
* `GREASE_MONGO_PORT`: MongoDB Port (Defaults to 27017)
* `GREASE_MONGO_USER`: MongoDB Auth Username
* `GREASE_MONGO_PASSWORD`: MongoDB Auth Password
* `GREASE_MONGO_DB`: Database Name (defaults to grease)
1. Python2.7
2. Pip
* psycopg2
* requests
* pymongo
* sqlalchemy
* python-dotenv
* psutil

0 comments on commit c757f47

Please sign in to comment.