This repository has been archived by the owner on Nov 6, 2019. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This adds a small set of contribution guidelines as well as the Manifold Code of Conduct.
- Loading branch information
1 parent
35f891d
commit 14acbe9
Showing
3 changed files
with
147 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
# 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 behaviour 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 behaviour 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 behaviour and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behaviour. | ||
|
||
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 behaviours 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@manifold.co](mailto:hello@manifold.co). 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, version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,94 @@ | ||
# Contributing | ||
|
||
Thanks for taking the time to join the community and helping out! These | ||
guidelines will help you get started with the Heighliner project. | ||
|
||
Please note that we have a [CLA sign off](https://cla-assistant.io/manifoldco/heighliner). | ||
|
||
## Building from source | ||
|
||
### Prerequisites | ||
|
||
1. Install 1Go1 | ||
|
||
Heighliner requires [Go 1.9][1] or later. | ||
|
||
2. Install `dep` | ||
|
||
Heighliner uses [dep][1] for dependency management. | ||
|
||
``` | ||
go get -u github.com/golang/dep/cmd/dep | ||
``` | ||
|
||
### Downloading the source | ||
|
||
To reduce the size of the repository, Heighliner does not include a copy of its | ||
dependencies. It uses [dep][2] to manage its dependencies. | ||
|
||
We might change this in the future, but for now, you can use the following | ||
commands to fetch the Heighliner source and its dependencies: | ||
|
||
``` | ||
go get -d github.com/manifoldco/heighliner | ||
cd $GOPATH/src/github.com/manifoldco/heighliner | ||
make vendor | ||
``` | ||
|
||
Go has strict rules when it comes to the location of the source code in your | ||
`$GOPATH`. The easiest way to develop is to rename the Heighliner git remote | ||
location and substitute your own fork for `origin`. We want to ensure that the | ||
repository remains at `$GOPATH/src/github.com/manifoldco/heighliner` on disk. | ||
|
||
``` | ||
git remote rename origin upstream | ||
git remote add origin git@github.com:jelmersnoeck/heighliner.git | ||
``` | ||
|
||
### Building | ||
|
||
To build the binaries, run: | ||
|
||
``` | ||
make bins | ||
``` | ||
|
||
This will put all the binaries into the `./bins` folder. These binaries are | ||
compiled for your local machine. | ||
|
||
To compile a docker image to deploy in your local cluster, there are two | ||
options. The first options is to run | ||
|
||
``` | ||
make docker-dev | ||
``` | ||
|
||
This will generate the binary on the host - your machine - and put it in a | ||
Docker image. | ||
|
||
To create a more official image, you can run: | ||
|
||
``` | ||
make docker | ||
``` | ||
|
||
This will install all dependencies in the Docker image and build the container | ||
in that image. This means that all build artifacts are linked within the same | ||
Docker structure. | ||
|
||
### Testing | ||
|
||
Once you have Heighliner built, you can run the tests: | ||
|
||
``` | ||
make test | ||
``` | ||
|
||
We also have a set of linters that we require, these can be run as follows: | ||
|
||
``` | ||
make lint | ||
``` | ||
|
||
[1]: https://golang.org | ||
[2]: https://github.com/golang/dep |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters