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

Common contributing rules #515

Merged
merged 1 commit into from May 22, 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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Expand Up @@ -34,7 +34,7 @@ This Code of Conduct applies both within project spaces and in public spaces whe

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at marcin.czeczko@gmail.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [Gitter Chat](https://gitter.im/Knotx/Lobby). The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

Expand Down
12 changes: 8 additions & 4 deletions CONTRIBUTING.md
Expand Up @@ -3,8 +3,9 @@ Thank you for taking the time to contribute!
We appreciate all commits and improvements, feel free to join Knot.x community and contribute.

## How to start
See [knotx.io](http://knotx.io/tutorials) for tutorials, examples and user documentation.
See [Knot.x Example Project](https://github.com/Knotx/knotx-example-project) for usage examples.
- See [knotx.io](https://knotx.io/tutorials) for tutorials and examples.
- You will findand user documentation in every repository at https://github.com/Knotx in a form of markdown documents.
- See [Knot.x Example Project](https://github.com/Knotx/knotx-example-project) for usage examples.

## Knot.x Contributor License Agreement
Project License: [Apache License Version 2.0](https://github.com/Knotx/knotx/blob/master/LICENSE)
Expand Down Expand Up @@ -36,7 +37,10 @@ Please add the following lines to your pull request description:

I hereby agree to the terms of the Knot.x Contributor License Agreement.
```
Every pull request has to contain a single commit. So please remember to rebase with master and squash all commits.

After the code review process, we kindly ask you to squash all commits so that every pull request contains a single commit before it is merged.

Before mreging, please remember to rebase with `master` and squash all commits, e.g. with:
```
git rebase master
git rebase -i HEAD~3
Expand All @@ -56,7 +60,7 @@ Please use convention `- [PR-ABC](https://github.com/Knotx/REPOSITORY/pull/ABC)

## Upgrade Notes
When changing or fixing anything related with changes in Knot.x configuration (e.g. its structure, new property etc.) or
snippet structure (e.g. change convention of naming services) remember to update include short description in your PR.
snippet structure (e.g. change convention of naming services) remember to include short description in your PR under `Upgrade Notes`.

## Tests naming convention
Tests written in Knot.x should use Junit 5 `@DisplayName` annotation with proper description.
Expand Down