Skip to content

Commit

Permalink
Polishing readme (#151)
Browse files Browse the repository at this point in the history
- add slack channel
- add link to code of conduct
- add contribution doc

Signed-off-by: Scott Andrews <scott@andrews.me>
  • Loading branch information
scothis authored Aug 24, 2024
1 parent 56e4760 commit 6a6909f
Show file tree
Hide file tree
Showing 2 changed files with 104 additions and 1 deletion.
75 changes: 75 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@


# Contributing to reconciler.io runtime

The reconciler.io runtime project team welcomes contributions from the community. A contributor license agreement (CLA) is not required. You own full rights to your contribution and agree to license the work to the community under the Apache License v2.0, via a [Developer Certificate of Origin (DCO)](https://developercertificate.org).

## Contribution Flow

This is a rough outline of what a contributor's workflow looks like:

- Create a topic branch from where you want to base your work
- Make commits of logical units
- Make sure your commit messages are in the proper format (see below)
- Push your changes to a topic branch in your fork of the repository
- Submit a pull request

Example:

``` shell
git remote add upstream https://github.com/reconcilerio/runtime.git
git checkout -b my-new-feature main
git commit -a
git push origin my-new-feature
```

### Staying In Sync With Upstream

When your branch gets out of sync with the reconcilerio/main branch, use the following to update:

``` shell
git checkout my-new-feature
git fetch -a
git pull --rebase upstream main
git push --force-with-lease origin my-new-feature
```

### Updating pull requests

If your PR fails to pass CI or needs changes based on code review, you'll most likely want to squash these changes into
existing commits.

If your pull request contains a single commit or your changes are related to the most recent commit, you can simply
amend the commit.

``` shell
git add .
git commit --amend
git push --force-with-lease origin my-new-feature
```

If you need to squash changes into an earlier commit, you can use:

``` shell
git add .
git commit --fixup <commit>
git rebase -i --autosquash main
git push --force-with-lease origin my-new-feature
```

Be sure to add a comment to the PR indicating your new changes are ready to review, as GitHub does not generate a
notification when you git push.

### Code Style

### Formatting Commit Messages

We follow the conventions on [How to Write a Git Commit Message](http://chris.beams.io/posts/git-commit/).

Be sure to include any related GitHub issue references in the commit message. See
[GFM syntax](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown) for referencing issues
and commits.

## Reporting Bugs and Creating Issues

When opening a new issue, try to roughly follow the commit message format conventions above.
30 changes: 29 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,12 @@
- [die markers](#die-markers)
- [+die](#die)
- [+die:field](#diefield)
- [Community](#community)
- [Code of Conduct](#code-of-conduct)
- [Communication](#communication)
- [Contributing](#contributing)
- [Acknowledgements](#acknowledgements)
- [License](#license)

---

Expand Down Expand Up @@ -542,4 +548,26 @@ Properties:
- `atomic`: the list is replaced
- **listMapKey** `string` (optional): defaults to `Name` for map list types (only for list type map)
- **listMapKeyPackage** `string` (optional): the go package containing the type representing the key field on the target struct, defaults to the current package (only for list type map)
- **listMapKeyType** `string` (optional): the go type representing the key field on the target struct, defaults to `string` (only for list type map)
- **listMapKeyType** `string` (optional): the go type representing the key field on the target struct, defaults to `string` (only for list type map)
## Community
### Code of Conduct
The reconciler.io projects follow the [Contributor Covenant Code of Conduct](./CODE_OF_CONDUCT.md). In short, be kind and treat others with respect.
### Communication
General discussion and questions about the project can occur either on the Kubernetes Slack [#reconcilerio](https://kubernetes.slack.com/archives/C07J5G9NDHR) channel, or in the project's [GitHub discussions](https://github.com/orgs/reconcilerio/discussions). Use the channel you find most comfortable.
### Contributing
The reconciler.io dies project team welcomes contributions from the community. A contributor license agreement (CLA) is not required. You own full rights to your contribution and agree to license the work to the community under the Apache License v2.0, via a [Developer Certificate of Origin (DCO)](https://developercertificate.org). For more detailed information, refer to [CONTRIBUTING.md](CONTRIBUTING.md).
## Acknowledgements
`dies` was conceived by [Scott Andrews](https://github.com/scothis) drawing inspiration from previous work in [`reconciler.io/runtime`](https://github.com/reconcilerio/runtime/).
## License
Apache License v2.0: see [LICENSE](./LICENSE) for details.

0 comments on commit 6a6909f

Please sign in to comment.