Skip to content

Commit

Permalink
Add repo files
Browse files Browse the repository at this point in the history
  • Loading branch information
valendesigns committed Feb 28, 2019
1 parent 0b1a142 commit e041a67
Show file tree
Hide file tree
Showing 5 changed files with 183 additions and 6 deletions.
46 changes: 46 additions & 0 deletions CODE_OF_CONDUCT.md
@@ -0,0 +1,46 @@
# 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, 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 engage@xwp.co. The project team will review and investigate all complaints, and will respond in a way that it deems 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 [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
31 changes: 31 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,31 @@
# Tide Contributing Guide

Before submitting your contribution, please make sure to take a moment and read
through the following guidelines.

## Code of Conduct

This project and everyone participating in it is governed by the
[Tide Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected
to uphold this code. Please report unacceptable behavior to engage@xwp.co.

## Issue Reporting Guidelines

- The Issue list of this repo is **exclusively** for bug reports and feature requests.
- Try to search for your issue, it may have already been answered or even fixed in the `develop` branch.
- Check if the issue is reproducible with the latest stable version. If you are using a pre-release, please indicate the specific version you are using.
- It is **required** that you clearly describe the steps necessary to reproduce the issue you are running into. Issues without clear reproducible steps will be closed immediately.
- If your issue is resolved but still open, don't hesitate to close it. In case you found a solution by yourself, it could be helpful to explain how you fixed it.

## Pull Request Guidelines

- Checkout a topic branch from `develop` and merge back against `develop`.
- If you are not familiar with branching please read [_A successful Git branching model_](http://nvie.com/posts/a-successful-git-branching-model/) before you go any further.
- If adding a new feature:
- Add accompanying test case.
- Provide convincing reason to add this feature. Ideally you should open a suggestion issue first and have it green-lit before working on it.
- If fixing a bug:
- Provide detailed description of the bug in the PR. Live demo preferred.
- Add appropriate test coverage if applicable.

Travis CI will run the unit tests whenever you push changes to your PR. Tests are required to pass successfully for a merge to be considered.
47 changes: 47 additions & 0 deletions ISSUE_TEMPLATE.md
@@ -0,0 +1,47 @@
<!--
Have you read [Tide's Code of Conduct](CODE_OF_CONDUCT.md)? By filing an Issue, you are expected to comply with it, including treating everyone with respect.
Do you want to ask a question? Are you looking for support? The [`#tide` channel](https://wordpress.slack.com/messages/C7TK8FBUJ/) in [WordPress Slack](https://make.wordpress.org/chat/) is the best place for getting support.
BEFORE POSTING YOUR ISSUE:
- These comments won't show up when you submit the issue.
- Try to add as much detail as possible, please de specific.
- If you're requesting a new feature, explain why you'd like it to be added.
- Ensure you are using the latest code before logging bugs.
-->

## Issue Overview
<!-- This is a brief overview of the issue --->

## Steps to Reproduce (for bugs)
<!-- Provide a link to a live example, or an unambiguous set of steps to -->
<!-- reproduce this bug. Include code to reproduce, if relevant. -->
1.
2.
3.
4.
<!-- Provide what browser you are using and any other specifics to your setup -->

## Expected Behavior
<!-- If you're describing a bug, tell us what should happen. -->
<!-- If you're suggesting a new feature, tell us how it should work. -->

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

## Possible Solution
<!-- Not obligatory, but suggest a fix/reason for the bug, -->
<!-- or ideas how to implement the new feature. -->

## Screenshots / Video
<!-- Visual records are oxygen for others to understand what you are sharing. -->

## Related Issues and/or PRs
<!-- List related issues or PRs against other branches. -->

## Todos
- [ ] Tests
- [ ] Documentation
42 changes: 42 additions & 0 deletions PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,42 @@
### Requirements

* Filling out the template is required. Any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion.
* All new code requires tests to ensure against regressions.

### Description of the Change

<!--
We must be able to understand the design of your change from this description. If we can't get a good idea of what the code will be doing from the description here, the pull request may be closed at the maintainers' discretion. Keep in mind that the maintainer reviewing this PR may not be familiar with or have worked with the code here recently, so please walk us through the concepts.
-->

### Alternate Designs

<!-- Explain what other alternates were considered and why the proposed version was selected. -->

### Benefits

<!-- What benefits will be realized by the code change? -->

### Possible Drawbacks

<!-- What are the possible side-effects or negative impacts of the code change? -->

### Verification Process

<!--
What process did you follow to verify that your change has the desired effects?
- How did you verify that all new functionality works as expected?
- How did you verify that all changed functionality works as expected?
- How did you verify that the change has not introduced any regressions?
Describe the actions you performed (e.g., commands you ran, text you typed, buttons you clicked) and describe the results you observed.
-->

### Applicable Issues

<!-- Enter any applicable Issues here -->
23 changes: 17 additions & 6 deletions README.md
@@ -1,12 +1,10 @@
# github.com/wptide/pkg
# Tide Go Packages

[![Build Status](https://travis-ci.org/wptide/pkg.svg?branch=master)](https://travis-ci.org/wptide/pkg) [![Coverage Status](https://coveralls.io/repos/github/wptide/pkg/badge.svg?branch=master)](https://coveralls.io/github/wptide/pkg?branch=master) [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

This repository contains common packages that are used for the development of
Tide related services.
This repository contains common packages that are used for the development of Tide related services.

The packages can be added to your project using a Go package dependency manager (e.g. [glide](https://github.com/Masterminds/glide)
or [golang/dep](https://github.com/golang/dep)) or added to your GOPATH using `go get`.
The packages can be added to your project using a Go package dependency manager (e.g. [glide](https://github.com/Masterminds/glide) or [golang/dep](https://github.com/golang/dep)) or added to your `$GOPATH` using `go get`.

```
go get github.com/wptide/pkg
Expand All @@ -15,12 +13,25 @@ go get github.com/wptide/pkg
All packages have been tested and provide 100% coverage (except for third-party packages that do not provide adequate interfaces). We expect nothing less from any contributions to this project.

Test can be run inside each package using the `go test` command or the convenience instruction in the provided `Makefile` (`make` required) by typing:

```
make test
```

This is a library of packages and is meant to be imported into Go projects.

## Contributing

Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct,
and the process for submitting pull requests to us.

## Contact Us

Have questions? Don't open an Issue, come join us in the [`#tide` channel](https://wordpress.slack.com/messages/C7TK8FBUJ/) in [WordPress Slack](https://make.wordpress.org/chat/). Even though Slack is a chat service, sometimes it takes several hours for community members to respond — please be patient.

## Props

[@rheinardkorf](https://github.com/rheinardkorf), [@valendesigns](https://github.com/valendesigns)
[@rheinardkorf](https://github.com/rheinardkorf), [@valendesigns](https://github.com/valendesigns)

## License
Tide `pkg` utilizes an [MIT license](LICENSE).

0 comments on commit e041a67

Please sign in to comment.