Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added changelog and community support files
- Loading branch information
Maciej Laskowski
committed
Oct 10, 2018
1 parent
de35216
commit d0b3c31
Showing
6 changed files
with
188 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
|
||
--- | ||
|
||
**Describe the bug** | ||
A clear and concise description of what the bug is. Make sure to include a version o Knot.x you use. | ||
|
||
**To Reproduce** | ||
Steps to reproduce the behavior: | ||
1. Go to '...' | ||
2. Click on '....' | ||
3. Scroll down to '....' | ||
4. See error | ||
|
||
**Expected behavior** | ||
A clear and concise description of what you expected to happen. | ||
|
||
**Screenshots** | ||
If applicable, add screenshots to help explain your problem. | ||
|
||
**Additional context** | ||
Add any other context about the problem here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for this project | ||
|
||
--- | ||
|
||
**Is your feature request related to a problem? Please describe.** | ||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
||
**Describe the solution you'd like** | ||
A clear and concise description of what you want to happen. | ||
|
||
**Describe alternatives you've considered** | ||
A clear and concise description of any alternative solutions or features you've considered. | ||
|
||
**Additional context** | ||
Add any other context or screenshots about the feature request here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
<!--- Provide a general summary of your changes in the Title above --> | ||
|
||
## Description | ||
<!--- Describe your changes in detail --> | ||
|
||
## Motivation and Context | ||
<!--- Why is this change required? What problem does it solve? --> | ||
<!--- If it fixes an open issue, please link to the issue here. --> | ||
|
||
## Screenshots (if appropriate) | ||
|
||
## Upgrade notes (if appropriate) | ||
<!-- What changes user have to do in order to migrate from the previous version to the version with this feature --> | ||
|
||
## Types of changes | ||
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> | ||
- [ ] Bug fix (non-breaking change which fixes an issue) | ||
- [ ] New feature (non-breaking change which adds functionality) | ||
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) | ||
|
||
## Checklist: | ||
<!--- Go over all the following points, and put an `x` in all the boxes that apply. --> | ||
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> | ||
- [ ] My code follows the [code style](/CONTRIBUTING.md#coding-conventions) of this project. | ||
- [ ] My change requires a change to the documentation. | ||
- [ ] I have updated the documentation accordingly. | ||
|
||
--- | ||
I hereby agree to the terms of the Knot.x Contributor License Agreement. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# Changelog | ||
All notable changes to `knotx-example-project` will be documented in this file. | ||
|
||
## Unreleased | ||
List of changes that are finished but not yet released in any final version. | ||
|
||
## 1.4.0 | ||
- [PR-19](https://github.com/Knotx/knotx-example-project/pull/19) - Fixed http repo headers conifg | ||
|
||
## 1.3.0 | ||
Initial open source release. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
# Contributor Covenant Code of Conduct | ||
|
||
## Our Pledge | ||
|
||
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to creating a positive environment include: | ||
|
||
* Using welcoming and inclusive language | ||
* Being respectful of differing viewpoints and experiences | ||
* Gracefully accepting constructive criticism | ||
* Focusing on what is best for the community | ||
* Showing empathy towards other community members | ||
|
||
Examples of unacceptable behavior by participants include: | ||
|
||
* The use of sexualized language or imagery and unwelcome sexual attention or advances | ||
* Trolling, insulting/derogatory comments, and personal or political attacks | ||
* Public or private harassment | ||
* Publishing others' private information, such as a physical or electronic address, without explicit permission | ||
* Other conduct which could reasonably be considered inappropriate in a professional setting | ||
|
||
## Our Responsibilities | ||
|
||
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. | ||
|
||
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. | ||
|
||
## Enforcement | ||
|
||
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. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] | ||
|
||
[homepage]: http://contributor-covenant.org | ||
[version]: http://contributor-covenant.org/version/1/4/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
![Knot.x logo](http://knotx.io/img/logo-knotx.png) | ||
|
||
# How to contribute to Knot.x | ||
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 | ||
Please refer to [README.md](README.md) file in this repository. | ||
|
||
## Knot.x Contributor License Agreement | ||
Project License: [Apache License Version 2.0](https://www.apache.org/licenses/LICENSE-2.0) | ||
- You will only Submit Contributions where You have authored 100% of the content. | ||
- You will only Submit Contributions to which You have the necessary rights. This means that if You are employed You have received the necessary permissions from Your employer to make the Contributions. | ||
- Whatever content You Contribute will be provided under the Project License(s). | ||
|
||
## Commit Messages | ||
When writing a commit message, please follow the guidelines in [How to Write a Git Commit Message](http://chris.beams.io/posts/git-commit/). | ||
|
||
## Pull Requests | ||
Please add the following lines to your pull request description: | ||
|
||
``` | ||
--- | ||
I hereby agree to the terms of the Knot.x Contributor License Agreement. | ||
``` | ||
|
||
## Documentation | ||
All documentation for this repository will be kept in the [`README.md`](README.md) file. If you would like to create a tutorial descibing how to use this module you are most welcome to contribute a [Knot.x tutorial](https://github.com/Knotx/knotx-website#tutorials) to knotx.io(http://knotx.io/tutorials/. | ||
|
||
## Changelog | ||
When changing or fixing some important part of Knot.x, please remember to update [Changelog](CHANGELOG.md). | ||
Your entry should be enlisted in `Unreleased` section. It will be moved to appropriate release notes when released. | ||
Please use convention `- [PR-ABC](https://github.com/Knotx/${knotx-repository}/pull/ABC) - short description of the PR.`. | ||
|
||
## 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 include detailed description of changes that needs to be done in order to upgrade from the latest version o Knot.x in the `Upgrade notes` section of the issue. | ||
This information will be later included in the [Release Notes blog post](http://knotx.io/blog/). | ||
|
||
## Tests naming convention | ||
Tests written in Knot.x should be named with `methodName_whenStateUnderTest_expectBehavior` convention proposed as the first example in [7 Popular Unit Test Naming Conventions](https://dzone.com/articles/7-popular-unit-test-naming). | ||
|
||
### Examples: | ||
**Unit tests** | ||
`canServeRequest_whenNoFormIdAndPostAttribute_expectRequestNotServed` | ||
|
||
**Integration tests** | ||
In integration tests method name is omitted, and test class name should suggest what part of system we test: | ||
`whenRepositoryDidNotReturnTemplateBody_expectNoSnippetsProcessing` | ||
|
||
## Coding Conventions | ||
Below is short list of things that will help us keep Knot.x quality and accept pull requests: | ||
- Follow Google Style Guide code formatting from Knot.x Github, particularly set your IDE `tab size`/`ident` to 2 spaces and `continuation ident` to 4 spaces. | ||
- [Google Style Guide for Eclipse](https://raw.githubusercontent.com/google/styleguide/gh-pages/eclipse-java-google-style.xml) | ||
- [Google Style Guide for IntelliJ](https://raw.githubusercontent.com/google/styleguide/gh-pages/intellij-java-google-style.xml) | ||
- write tests (integration and Unit Tests) following defined convention, | ||
- write javadoc, especially for interfaces and abstract methods, | ||
- update [`README.md`](README.md) for any documentation updates, | ||
- when logging use proper levels: `INFO` and `WARNING` should log only very important messages. |