Permalink
Browse files

add issue and PR templates, code of conduct, and contributing file to…

… enforce good contributor behavior
  • Loading branch information...
cmlicata committed Sep 7, 2017
1 parent 98e02d9 commit ccfa20ebcfafa5982bdf53cb4bd1ee1a8758eab7
Showing with 160 additions and 29 deletions.
  1. +20 −0 .github/ISSUE_TEMPLATE.md
  2. +18 −0 .github/PULL_REQUEST_TEMPLATE.md
  3. +73 −0 CODE_OF_CONDUCT.md
  4. +46 −0 CONTRIBUTING.md
  5. +3 −29 README.md
@@ -0,0 +1,20 @@
## Summary / Context
<!--- Context in which this is relevant: scenario -->

## Expected Behavior
<!--- If you are describing a bug, tell us what should happen -->
<!--- If you are suggesting a change/improvement, tell us how it should work -->

## Current Behavior
<!--- If describing a bug, tell us what happens instead of the expected behavior -->
<!--- If suggesting a change/improvement, explain the difference from current behavior -->

## Steps
<!--- Provide a link to a live example, or an unambiguous set of steps to -->
<!--- reproduce this bug. Include code to reproduce, if relevant. Screenshots are great -->
1.
1.

## Suggestions for Solution
<!--- Not obligatory, but suggest a fix/reason for the bug, -->
<!--- or ideas how to implement the addition or change -->
@@ -0,0 +1,18 @@
## Motivation
<!--- Describe what this change accomplishes -->

## Related Issue
<!--- Please link to the issue describing details of the solution and background -->

## Steps to Test:
<!--- Please describe in detail how I can test your changes. -->
1.
1.
1.

## Suggested sequence to review files in:
1.
1.
1.

## Final comments
@@ -0,0 +1,73 @@
# Contributor 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, 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 [here](mailto:chris@chrislicata.io). 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/

[homepage]: https://www.contributor-covenant.org
@@ -0,0 +1,46 @@
# Contributing to the CLI Interface
Contributions are always welcome, no matter how large or small. Substantial feature requests should be proposed as an [RFC](https://github.com/apiaryio/api-blueprint-rfcs/blob/master/template.md). Before contributing, please read the [code of conduct](https://github.com/inadarei/justgo/blob/master/CODE_OF_CONDUCT.md).

## Setup

### Prerequisites

- Latest Go version (al teast 1.8+)
- Properly set up `$GOPATH` and `GOPATH/bin` added to `$PATH`
- Go's Dep tool installed:
- Install via: `go get -u github.com/golang/dep/cmd/dep`

### Dev Workspace Setup

```BASH
> cd $GOPATH/src
> mkdir -p github.com/inadarei/
> git clone https://github.com/inadarei/justgo.git
> cd justgo/
> dep ensure
> go run justgo.go <someFolderToTestInstallTo>
```

### Warning for VS Code Users

If you are using VS Code with Go tooling, you will want to change the default
`"go.formatTool": "goreturns",` formatter to `"go.formatTool": "gofmt",` instead
since the former seems unable to properly detect the usage of uuid in the code
and keeps removing the uuid package's import statement from code, making it
error-out during a build. Gofmt has no such issues.

## Pull Requests

We actively welcome your pull requests.

1. Create an Issue or RFC for your contribution.
1. Fork the repo and create your branch from `master`.
1. If you've added code that should be tested, add tests.
1. Update the documentation.
1. Ensure the test suite passes.
1. Run gofmt and goimports.

## License

By contributing to Justgo, you agree that your contributions will be licensed
under its [MIT license](LICENSE).
@@ -54,36 +54,10 @@ project, once it is created, see
> brew upgrade justgo
```

## Contributing to the CLI Interface
## Contributing
Contributions are always welcome, no matter how large or small. Substantial feature requests should be proposed as an [RFC](https://github.com/apiaryio/api-blueprint-rfcs/blob/master/template.md). Before contributing, please read the [code of conduct](https://github.com/inadarei/justgo/blob/master/CODE_OF_CONDUCT.md).

If you are interested in contributing to the development of this CLI tool,
following are the instructions for setting up a dev environment:

### Prerequisites

- Latest Go version (al teast 1.8+)
- Properly set up `$GOPATH` and `GOPATH/bin` added to `$PATH`
- Go's Dep tool installed:
- Install via: `go get -u github.com/golang/dep/cmd/dep`

### Dev Workspace Setup

```BASH
> cd $GOPATH/src
> mkdir -p github.com/inadarei/
> git clone https://github.com/inadarei/justgo.git
> cd justgo/
> dep ensure
> go run justgo.go <someFolderToTestInstallTo>
```

### Warning for VS Code Users

If you are using VS Code with Go tooling, you will want to change the default
`"go.formatTool": "goreturns",` formatter to `"go.formatTool": "gofmt",` instead
since the former seems unable to properly detect the usage of uuid in the code
and keeps removing the uuid package's import statement from code, making it
error-out during a build. Gofmt has no such issues.
See [Contributing](CONTRIBUTING.md).

## License

0 comments on commit ccfa20e

Please sign in to comment.