Skip to content

Commit

Permalink
[FEAT] updating documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
nicolastakashi committed Oct 17, 2021
1 parent 945c69f commit f96bc34
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 1 deletion.
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,17 @@ Addresses #bugnumber (in this specific format)

You can contribute to Gitana Core with issues and PRs. Simply filing issues for problems you encounter is a great way to contribute. Contributing implementations is greatly appreciated.

For complete instructions on how to compile see: Building From Source

For quickly compiling and testing your changes do:

```bash
# For building.
make build

./bin/gitana
```

## Suggested Workflow

We use and recommend the following workflow:
Expand Down
32 changes: 31 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,34 @@ Gitana is a lightweight application that will help you sync Grafana dashboards f
- [ ] Create Helm Chart

# Contributing
Contributions are very welcome! See our [CONTRIBUTING.md](CONTRIBUTING.md) for more information.
Contributions are very welcome! See our [CONTRIBUTING.md](CONTRIBUTING.md) for more information.

## Docker images

Docker images are available on [Quay.io](https://quay.io) or [Docker Hub](https://hub.docker.com/).

## Building from source

To build Prometheus from source code, first ensure that you have a working
Go environment with [version 1.16 or greater installed](https://golang.org/doc/install).

To build the source code you can use the `make build`, which will compile in
the assets so that Gitana can be run from anywhere:

```bash

$ mkdir -p $GOPATH/src/github.com/gitana
$ cd $GOPATH/src/github.com/gitana
$ git clone https://github.com/nicolastakashi/gitana.git
$ cd gitana
$ make build
$ ./gitana sync <args>
```

The Makefile provides several targets:

* *build*: build the `gitana`
* *fmt*: format the source code
* *vet*: check the source code for common errors
<!-- * *test*: run the tests -->
<!-- * *test-short*: run the short tests -->

0 comments on commit f96bc34

Please sign in to comment.