Code of conduct, contribution and license

Author: edshadi

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 hello@expand.org. 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,111 @@
+# Contributing to expandorg/assignment
+
+:+1: First off, thanks for taking the time to contribute! :+1:
+
+We're excited to hear and learn from you. Your experiences will benefit others who read and use these guides.
+We've put together the following guidelines to help you figure out where you can best be helpful. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
+
+
+## Table of Contents
+
+0. [Types of contributions we're looking for](#types-of-contributions-were-looking-for)
+0. [How Can I Contribute?](#how-can-i-contribute)
+0. [Setting up your environment](#setting-up-your-environment)
+0. [Pull requests](#pull-requests)
+0. [License](#license)
+
+## Types of contributions we're looking for
+
+There are many ways you can directly contribute to the guides (in descending order of need):
+
+- Reporting a bug
+- Discussing the current state of the code
+- Submitting a fix
+- suggesting enhancements
+
+## How Can I Contribute?
+
+### Report bugs using Github's [issues](https://github.com/expandorg/assignment/issues)
+We use GitHub issues to track public bugs. Report a bug by [opening a new issue](); it's that easy! Write bug reports with detail, background, and sample code.
+
+**Great Bug Reports** tend to have:
+
+- A quick summary and/or background
+- Steps to reproduce
+  - Be specific!
+  - Give sample code if you can. 
+- What you expected would happen
+- What actually happens
+- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
+
+### Suggesting Enhancements
+How Do I Submit A Enhancement Suggestion?
+
+Enhancement suggestions are tracked as GitHub [issues](https://github.com/expandorg/assignment/issues). Create an issue on this repository and provide the following information:
+
+- Use a clear and descriptive title for the issue to identify the suggestion.
+- Provide a step-by-step description of the suggested enhancement in as many details as possible.
+- Describe the current behavior and explain which behavior you expected to see instead** and why.
+
+## Setting up your environment
+
+Clone the repository with: 
+
+`go get -u github.com/expandorg/assignment`
+
+or create a directory `$GOPATH/src/github/expandorg` and execute: git clone git@github.com:expandorg/assignment.git 
+
+Run the project dependencies (db, etc.) with `make up`
+Run the latest migration with `make migrate-latest`
+Run the project with `make run`
+
+### Dependencies
+
+We use `dep` to manage our dependencies. To add a new vendor, use: 
+
+`deps ensure -add DEPENDENCY`
+
+To update vendors for built project, run:
+
+`make update-deps`
+
+#### Add a new migration
+
+```make add-migration name="migration_name"```
+
+For migration names be descriptive and start with verbs: `create_`, `drop_`, `add_`, etc. This will look at the latest migrated version (1, 2, 3) and creates 2 files with new version:
+
+`2_migration_name.up.sql` and `2_migration_name.down.sql`
+
+#### Migrate
+
+You can migrate to latest:
+
+```make migrate-latest```
+
+OR You can migrate up and migrate down a version:
+
+```make run-migrations action="goto" version="1"```
+
+When you migrate up, you can see in the `schema_migrations` the last migrated version. When you migrate down, it updates the the version column in `schema_migrations`.
+
+### Tests
+```make run-tests```
+
+## Pull Requests
+We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests
+Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests:
+
+1. Fork the repo and create your branch from `master`.
+2. If you've added code that should be tested, add tests.
+3. If you've changed APIs, update the documentation.
+4. Ensure the test suite passes.
+5. Make sure your code lints.
+6. Issue that pull request!
+
+## License
+By contributing, you agree that your contributions will be licensed under its MLP-2 License.
+
+Thanks! :heart:
+
+Expand.org Team