Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add CONTRIBUTING.md #325

Merged
merged 1 commit into from
Mar 8, 2024
+27 −3
Merged

add CONTRIBUTING.md #325

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# How to contribute

PRs are very welcome!

## Adding code

- Create a fork
- Create a branch
- Do your thing
- [Please sign all your commits](https://docs.github.com/de/authentication/managing-commit-signature-verification)
- Create a PR
- Reference issues if applicable

## Found a bug?

- Please open an [issue](https://github.com/betadots/hdm/issues)
- If you are able to fix it, you also can open a PR (see above)

## Have an idea?

- Please start a [discussion](https://github.com/betadots/hdm/discussions)
9 changes: 6 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Copyright 2023 betadots GmbH

This Rails application displays [Puppet](https://github.com/puppetlabs/puppet) Hiera data and offers a WebGUI to read/update/create that configuration.

You can find screenshots in the [screenshots](screenshots) directory.
You can find screenshots in the [screenshots](SCREENSHOTS.md).

## Manual installation

Expand Down Expand Up @@ -124,7 +124,7 @@ want to make sure that your repository is only edited by HDM.

Don't forget to set SECRET_KEY_BASE env var in docker run, docker-compose, systemd or hieradata.

```
```shell
openssl rand -hex 16
9dea7603c008dec285e4b231602a00b2
Expand All @@ -136,7 +136,6 @@ docker run -it --rm -p 3000:3000 -e DEVELOP=1 -e SECRET_KEY_BASE=9dea7603c008dec

See [`docker-compose.yaml`](docker-compose.yaml).

### Update db file

Move existing db/development.sqlite3 to db/production.sqlite3
Expand All @@ -146,3 +145,7 @@ docker exec -it <container_id> bash
mv db/development.sqlite3 db/production.sqlite3
bin/rails db:environment:set RAILS_ENV=production
```

## How to contribute?

see [CONTRIBUTING.md](CONTRIBUTING.md)