Skip to content

Commit

Permalink
chore: Standardize the repo for release
Browse files Browse the repository at this point in the history
  • Loading branch information
pojntfx committed Feb 24, 2023
1 parent 371d00e commit 6994dcc
Show file tree
Hide file tree
Showing 4 changed files with 46 additions and 145 deletions.
132 changes: 0 additions & 132 deletions CODE_OF_CONDUCT.md

This file was deleted.

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

To build and start a development version of LatenSee locally, run the following:

```shell
$ git clone https://github.com/loopholelabs/latensee.git
$ cd latensee
$ go generate ./...
$ go run .
```

Note that you can also set `HYDRAPP_BACKEND_LADDR` to a fixed value, `HYDRAPP_TYPE` to `dummy` and serve the frontend yourself to develop in your browser of choice directly.

LatenSee uses GitHub to manage reviews of pull requests.

- If you have a trivial fix or improvement, go ahead and create a pull request,
addressing (with `@...`) the maintainer of this repository (see
[MAINTAINERS.md](MAINTAINERS.md)) in the description of the pull request.

- If you plan to do something more involved, first discuss your ideas
on our [discord](https://loopholelabs.io/discord).
This will avoid unnecessary work and surely give you and us a good deal
of inspiration.

- Relevant coding style guidelines are the [Go Code Review
Comments](https://code.google.com/p/go-wiki/wiki/CodeReviewComments)
and the _Formatting and style_ section of Peter Bourgon's [Go: Best
Practices for Production
Environments](http://peter.bourgon.org/go-in-production/#formatting-and-style).

- Be sure to sign off on the [DCO](https://github.com/probot/dco#how-it-works)
1 change: 1 addition & 0 deletions MAINTAINERS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
- Felicitas Pojtinger <[email protected]> @pojntfx
27 changes: 14 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
Redis latency visualizer.

[![hydrapp CI](https://github.com/loopholelabs/latensee/actions/workflows/hydrapp.yaml/badge.svg)](https://github.com/loopholelabs/latensee/actions/workflows/hydrapp.yaml)
[![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-brightgreen.svg)](https://www.apache.org/licenses/LICENSE-2.0)

## Overview

Expand Down Expand Up @@ -33,25 +34,25 @@ All arguments passed to the binary will be forwarded to the browser used to disp
## Acknowledgements

- [pojntfx/hydrapp](https://github.com/pojntfx/hydrapp) provides the application framework.
- [Font Awesome](https://fontawesome.com/) provides the assets used for the icon
- [Font Awesome](https://fontawesome.com/) provides the assets used for the icon and logo.
- [go-redis/redis](https://github.com/redis/go-redis) provides the Redis client.

## Contributing

To contribute, please use the [GitHub flow](https://guides.github.com/introduction/flow/) and follow our [Code of Conduct](./CODE_OF_CONDUCT.md).
Bug reports and pull requests are welcome on GitHub at [https://github.com/loopholelabs/latensee][gitrepo]. For more contribution information check out [the contribution guide](https://github.com/loopholelabs/latensee/blob/master/CONTRIBUTING.md).

To build and start a development version of LatenSee locally, run the following:
## License

```shell
$ git clone https://github.com/loopholelabs/latensee.git
$ cd latensee
$ go generate ./...
$ go run .
```
The LatenSee project is available as open source under the terms of the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).

Note that you can also set `HYDRAPP_BACKEND_LADDR` to a fixed value, `HYDRAPP_TYPE` to `dummy` and serve the frontend yourself to develop in your browser of choice directly.
## Code of Conduct

## License
Everyone interacting in the LatenSee project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).

## Project Managed By:

LatenSee (c) 2023 Felicitas Pojtinger and contributors
[![https://loopholelabs.io][loopholelabs]](https://loopholelabs.io)

SPDX-License-Identifier: Apache-2.0
[gitrepo]: https://github.com/loopholelabs/latensee
[loopholelabs]: https://cdn.loopholelabs.io/loopholelabs/LoopholeLabsLogo.svg
[loophomepage]: https://loopholelabs.io

0 comments on commit 6994dcc

Please sign in to comment.