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.

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

Apply component template to commodore itself #145

Merged
merged 6 commits into from
Jul 23, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/01_bug_report.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: 🐜 Bug report
about: Create a report to help us improve 🔧

labels: bug
---

<!-- Place a general description or your issue here. -->
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/02_feature_request.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: 🚀 Feature request
about: Suggest an idea for this project 💡

labels: enhancement
---

## Context
Expand Down
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
* `compile` and `clean` commands were moved to the `catalog` command group ([#122])
* `new-component` command was moved to the `component` command group ([#122])
* Jsonnet library file extension to `.libsonnet` in component template ([#137])
* Applied the component template to Commodore itself ([#145])

### Fixed

Expand Down Expand Up @@ -116,3 +117,4 @@ Initial implementation
[#137]: https://github.com/projectsyn/commodore/pull/137
[#140]: https://github.com/projectsyn/commodore/pull/140
[#143]: https://github.com/projectsyn/commodore/pull/143
[#145]: https://github.com/projectsyn/commodore/pull/145
4 changes: 4 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Code of Conduct

This code repository is part of Project Syn and the code of conduct at
https://syn.tools/syn/code_of_conduct.html does apply.
70 changes: 4 additions & 66 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,68 +1,6 @@
## Contributing
# How to contribute

### Compliance
This code repository is part of Project Syn and the contribution guide at
https://syn.tools/syn/contribution_guide.html does apply.

All commits need to be signed-off in accordance with the Developer Certificate of Origin (DCO) as per below.

#### License

This project is licensed under the [BSD 3-Clause License](https://choosealicense.com/licenses/bsd-3-clause/).

#### Sign your work

The sign-off is a simple line at the end of the explanation for a patch. Your
signature certifies that you wrote the patch or otherwise have the right to pass
it on as an open-source patch. The rules are pretty simple: if you can certify
the below (from [developercertificate.org](http://developercertificate.org/)):

```
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
have the right to submit it under the open source license
indicated in the file; or

(b) The contribution is based upon previous work that, to the best
of my knowledge, is covered under an appropriate open source
license and I have the right under that license to submit that
work with modifications, whether created in whole or in part
by me, under the same open source license (unless I am
permitted to submit under a different license), as indicated
in the file; or

(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.

(d) I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.
```

Then you just add a line to every git commit message:

Signed-off-by: Joe Smith <joe.smith@email.com>

Use your real name (sorry, no pseudonyms or anonymous contributions).

If you set your `user.name` and `user.email` git configs, you can sign your
commit automatically with `git commit -s`.

Example:

`git commit -s -m 'This is my commit message'`
Submit Pull Requests at https://github.com/projectsyn/commodore/pulls.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# Project Syn: Commodore

This repository is part of Project Syn.
For documentation on Project Syn and this component, see https://syn.tools.

**Please note that this project is in its early stages and under active development**.

See [CHANGELOG.md](/CHANGELOG.md) for changelogs of each release version of
Expand Down Expand Up @@ -148,6 +151,18 @@ docker-compose run commodore catalog compile $CLUSTER_ID

## Documentation

Documentation for this component is written using [Asciidoc][asciidoc] and [Antora][antora].
It is located in the [docs/](docs) folder.
The [Divio documentation structure](https://documentation.divio.com/) is used to organize its content.

Run the `make docs` command in the `docs` subfolder to generate the Antora documentation website locally. The website will be available at the `_antora/index.html` file.

After writing the documentation, please use the `make check` command and correct any warnings raised by the tool.

## Contributing and license

This library is licensed under [BSD-3-Clause](LICENSE).
For information about how to contribute see [CONTRIBUTING](CONTRIBUTING.md).

[asciidoc]: https://asciidoctor.org/
[antora]: https://antora.org/