Skip to content
This repository has been archived by the owner on Apr 23, 2022. It is now read-only.

Commit

Permalink
Cleanup before release
Browse files Browse the repository at this point in the history
  • Loading branch information
bjaroszewski committed Apr 19, 2019
1 parent af9a2c8 commit 16370b1
Show file tree
Hide file tree
Showing 78 changed files with 3,626 additions and 1,357 deletions.
77 changes: 77 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
# 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 [INSERT EMAIL ADDRESS]. 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

20 changes: 20 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Contributing

TODO

## Reporting an Issue

TODO

## Setup Development Environment

TODO

## Testing

TODO

## Opening a Pull Request

TODO

27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
(While submitting an issue briefly describe the problem you are facing or a new feature you would want to see added)

## What happens?

...

## What were you expecting to happen?

...

## Steps to reproduce:

* ...
* ...

## Any errors, stacktrace, logs?

...

## Environment:

* Runtime version(Java, Go, Python, etc):
* Desktop OS/version:

## Additional comments:

...
20 changes: 20 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Pull Request Template

## Description

Please provide a summary of the change and which issue it fixes.

Fixes #(issue)

## Type of change

Please delete options that are not relevant.

* Bug fix (non-breaking change which fixes an issue)
* New feature (non-breaking change which adds functionality)
* Breaking change (fix or feature that would cause existing functionality to not work as expected)
* This change requires a documentation update

## Environment

* Runtime version(Java, Go, Python, etc):
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
/vendor
/build/bin
.idea
*.swp
.vscode
20 changes: 20 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
language: go
matrix:
include:
- go: 1.10.x
- go: 1.11.x

before_install:
- go get github.com/golang/dep/cmd/dep
- go get golang.org/x/lint/golint

install:
- # skip

script:
- gofmt -d .
- golint $(go list ./... | grep -v /vendor/)
- go vet $(go list ./... | grep -v /vendor/)
- dep ensure
- go build
5 changes: 5 additions & 0 deletions ACKNOWLEDGEMENT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
## Acknolwedgement

Code base of git2consul.go tool is based on the excelent work done on [go-git2consul](https://github.com/Cimpress-MCP/go-git2consul) by [Calvin Leung Huang](https://github.com/calvn) under [Cimpress-MCP](https://github.com/Cimpress-MCP).

git2consul.go was forked from the upstream from the following commit: [af9a2c80e699411f7559d7f6c3d29680c4ebd7b2](https://github.com/Cimpress-MCP/go-git2consul/commit/af9a2c80e699411f7559d7f6c3d29680c4ebd7b2)
22 changes: 16 additions & 6 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,17 @@
## 0.1.0 (UNRELEASED)
## v0.1.0
#
#### Summary
Release v0.1.0 covers the basic functionality with added features enhancing path management of the keys in the Consul KV Store and authentication for private repositories (f.e. GitHub Enterprise).
#### Features

* Initial version of go-git2consul that contains basic functionality
* Handle repository files to KV, no support for file extensions yet
* Handle tracking branches
* Interval and webhook polling
* Handle CRUD operations, and perform updates on deltas
* Added atomicity to the Consul transactions
* Added mountpoint option which sets the prefix for added keys
* Added skip_branch option which skipps the branch name for the added keys
* Expand YAML file content to k:v
* Added source_root option which allows to point the root of the repository from which we want to process the data
* Added authentication (basic and ssh)

#### Bug fixes

* Fix for transactions - limited to 64 elements chunks
* Fixed reference "not found" issue on branch pull
22 changes: 22 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Contributing to git2consul

git2consul project is licensed under [Apache 2.0 license](LICENSE) and is open for contributions mainly via GitHub pull requests.

## How to Contribute

You can contribute to the project by submitting Pull Requests (PRs), submitting Issues that you found which will help us improve the git2consul, or by suggesting new features.

When submitting a Pull Request, we expect that it will pass following requirements:

- Your code must be written in an idiomatic Go.
- Formatted in accordance with the [gofmt](https://golang.org/cmd/gofmt).
- [go lint](https://github.com/golang/lint) shouldn't produce any warnings, same as [go vet](https://golang.org/cmd/vet)
- If you are submitting PR with a new feature, code should be covered with the suite of unit tests that test new functionality. Same rule applies for PRs that are bug fixes.

### Commit message format

Every commit message should contain information about package under which the changes were applied, short summary of the implemented changes and GitHub issue it relates to (if applicable):

```
<package>: <what has changed> [Fixes #<issue-number>]
```
34 changes: 0 additions & 34 deletions Godeps/Godeps.json

This file was deleted.

5 changes: 0 additions & 5 deletions Godeps/Readme

This file was deleted.

Loading

0 comments on commit 16370b1

Please sign in to comment.