generated from kontent-ai/repo-template
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 3a8b647
Showing
12 changed files
with
356 additions
and
0 deletions.
There are no files selected for viewing
Validating CODEOWNERS rules …
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,6 @@ | ||
# Users referenced in this file will automatically be requested as reviewers for PRs that modify the given paths. | ||
# See https://help.github.com/articles/about-code-owners/ | ||
|
||
# Format: <Path> <Maintainer Team name from: https://kontent-ai.github.io/Guidelines-for-GitHub-permissions-in-Kontent-ai-organization> | ||
# Example: * @kontent-ai/developer-relations | ||
* |
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,34 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
|
||
--- | ||
|
||
### Brief bug description | ||
|
||
What went wrong? | ||
|
||
### Repro steps | ||
|
||
1. Go to '...' | ||
2. Click on '....' | ||
3. Scroll down to '....' | ||
4. See error | ||
|
||
### Expected behavior | ||
|
||
What is the correct behavior? | ||
|
||
### Test environment | ||
|
||
- Platform/OS: [e.g. .NET Core 2.1, iOS] | ||
- Browser [e.g. chrome, safari] | ||
- Version [e.g. 22] | ||
|
||
### Additional context | ||
|
||
Add any other context about the problem here. | ||
|
||
### Screenshots | ||
|
||
Add links to screenshots, if possible. |
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 | ||
|
||
--- | ||
|
||
### Motivation | ||
|
||
Why is this feature required? What problems does it solve? | ||
|
||
### Proposed solution | ||
|
||
An ideal solution for the above problems. | ||
|
||
### Additional context | ||
|
||
Add any other context, screenshots, or reference links 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,13 @@ | ||
--- | ||
name: Question | ||
about: Ask a question | ||
|
||
--- | ||
|
||
### Question | ||
|
||
What do you want to ask? | ||
|
||
### Reference | ||
|
||
* URL |
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: Spike | ||
about: Suggest an analysis of a problem | ||
|
||
--- | ||
|
||
### Expected result | ||
|
||
What do we want to explore and why? Which questions do we want to answer with this spike? | ||
|
||
### Additional context | ||
|
||
Add any other context or guidelines here. | ||
|
||
### Resources | ||
|
||
* URL |
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 @@ | ||
### Motivation | ||
|
||
Which issue does this fix? Fixes #`issue number` | ||
|
||
If no issue exists, what is the fix or new feature? Were there any reasons to fix/implement things that are not obvious? | ||
|
||
### Checklist | ||
|
||
- [ ] Code follows coding conventions held in this repo | ||
- [ ] Automated tests have been added | ||
- [ ] Tests are passing | ||
- [ ] Docs have been updated (if applicable) | ||
- [ ] Temporary settings (e.g. variables used during development and testing) have been reverted to defaults | ||
|
||
### How to test | ||
|
||
If manual testing is required, what are the steps? |
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,14 @@ | ||
# For more information do to https://kontent-ai.github.io/ci-and-automation/ci-and-automation | ||
|
||
name: "Build" # Represents the name of the whole action. | ||
on: # Specifies the section where we describe our build triggers. | ||
push: # The action runs with push. | ||
pull_request: # The action runs with a pull request. | ||
schedule: # Specifies the section where we describe the schedule of running the action. | ||
- cron: '0 18 * * 1' # The CRON expression describes when to run the action. | ||
jobs: # Specifies the section where we describe our jobs. | ||
Build: # Specific job section. | ||
runs-on: ubuntu-latest # Describes the environment. | ||
steps: # Specifies the section where we describe the job's steps. | ||
- name: Output some string | ||
run: echo "Set some actual CI steps" |
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 [email protected]. 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 [https://contributor-covenant.org/version/1/4][version] | ||
|
||
[homepage]: https://contributor-covenant.org | ||
[version]: https://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,67 @@ | ||
# Ways to contribute | ||
<img align="right" width="100" height="100" src="https://i.imgur.com/PYTV0jP.png"> | ||
|
||
There are many different ways in which you can contribute. One of the easiest ways is simply to use our software and provide us with your feedback through the right channel. You can also help us improve the open-source projects by submitting pull requests with code and documentation changes. | ||
|
||
## Where to get support | ||
Please note that **level of provided support is always determined by the LICENSE** of a given open-source project. Also, always make sure you use the **[latest version](../../releases)** of any given OS project. We can't provide any help for older versions. We don't want to make things complicated so we try to take the same approach in all our repositories. | ||
|
||
### I found a bug in a Kontent.ai open-source project | ||
<img align="right" width="100" height="100" src="https://i.imgur.com/TYIQdpv.png"> | ||
|
||
Sorry to hear that. Just log a new [GitHub issue](../../issues) and someone will take a look at it. Remember, the more information you provide, the easier it will be to fix the issue. If you feel like it, you can also fix the bug on your own and submit a new pull request. | ||
|
||
### I need help with using the projects and/or coding | ||
<img align="right" width="100" height="100" src="https://cdn.sstatic.net/Sites/stackoverflow/company/img/logos/so/so-icon.svg"> | ||
|
||
To get help with coding and structuring your projects, use [StackOverflow](https://stackoverflow.com/) and tag your questions with [`kontent-ai`](https://stackoverflow.com/questions/tagged/kontent-ai) tag. | ||
|
||
Our team members and the community monitor these channels on a regular basis. | ||
|
||
### I want to report a security bug | ||
<img align="right" width="100" height="100" src="https://i.imgur.com/z82nnJB.png"> | ||
|
||
Security issues and bugs should be reported privately, via email, to Kontent.ai Security Team [[email protected]](mailto:[email protected]). For more details, check the [Security policy](SECURITY.md). | ||
|
||
### I have an idea for a new feature (or feedback on existing functionality) | ||
<img align="right" width="100" height="100" src="https://i.imgur.com/rUFkyPy.png"> | ||
|
||
Everybody loves new features! You can submit a new [feature request](../../issues) or you can code it on your own and [send us a pull request](#submitting-pull-requests). In either case, don't forget to mention what's the use case and what's the expected output. | ||
|
||
|
||
## Submitting pull requests | ||
<img align="right" width="100" height="100" src="https://i.imgur.com/aSeiliy.png"> | ||
|
||
Unless you're fixing a typo, it's usually a good idea to discuss the feature before you submit a pull request with code changes, so let's start with submitting a new [GitHub issue](../../issues) and discussing the whether it fits the vision of a given project. | ||
You might also read these two blogs posts on contributing code: [Open Source Contribution Etiquette](http://tirania.org/blog/archive/2010/Dec-31.html) by Miguel de Icaza and [Don't "Push" Your Pull Requests](https://www.igvita.com/2011/12/19/dont-push-your-pull-requests/) by Ilya Grigorik. Note that all code submissions will be rigorously reviewed and tested by Kontent.ai maintainer teams, and only those that meet an high bar for both quality and design/roadmap appropriateness will be merged into the source. | ||
|
||
|
||
### Example - process of contribution | ||
If not stated otherwise, we use [feature branch workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow). | ||
|
||
To start with coding, fork the repository you want to contribute to, create a new branch, and start coding. Once the functionality is [done](#Definition-of-Done), you can submit a [pull request](https://help.github.com/articles/about-pull-requests/). | ||
|
||
### Definition of Done | ||
<img align="right" width="100" height="100" src="https://i.imgur.com/g82Ohdv.png"> | ||
|
||
- New/fixed code is covered with tests | ||
- CI can build the code | ||
- All tests are pass | ||
- New version number follows [semantic versioning](https://semver.org/) | ||
- Coding style (spaces, indentation) is in line with the rest of the code in a given repository | ||
- Documentation is updated (e.g. code examples in README, Wiki pages, etc.) | ||
- All `public` members are documented (using XML doc, phpdoc, etc.) | ||
- Code doesn't contain any secrets (private keys, etc.) | ||
- Commit messages are clear. Please read these articles: [Writing good commit messages](https://github.com/erlang/otp/wiki/Writing-good-commit-messages), [A Note About Git Commit Messages](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html), [On commit messages](https://who-t.blogspot.com/2009/12/on-commit-messages.html) | ||
|
||
|
||
### Feedback | ||
<img align="right" width="100" height="100" src="https://i.imgur.com/ZQfNzJJ.png"> | ||
|
||
Your pull request will now go through extensive checks by the subject matter experts on our team. Please be patient. Update your pull request according to feedback until it is approved by one of Kontent.ai maintainers. After that, one of our team members may adjust the branch you merge into based on the expected release schedule. | ||
|
||
|
||
## Code of Conduct | ||
<img align="right" width="100" height="100" src="https://i.imgur.com/cObdKQy.png"> | ||
|
||
The Kontent.ai team is committed to fostering a welcoming community, therefore this project has adopted the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). If you have any additional questions or comments, you can contact us directly at [email protected]. |
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,21 @@ | ||
MIT License | ||
|
||
Copyright (c) [Current year here] Kontent s.r.o. | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
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,77 @@ | ||
[![Contributors][contributors-shield]][contributors-url] | ||
[![Forks][forks-shield]][forks-url] | ||
[![Stargazers][stars-shield]][stars-url] | ||
[![Issues][issues-shield]][issues-url] | ||
[![MIT License][license-shield]][license-url] | ||
|
||
[![Discord][discussion-shield]][discussion-url] | ||
|
||
<!-- ABOUT THE PROJECT --> | ||
## About The Project | ||
|
||
Please put here some general information about your Integration / App / Solution. | ||
|
||
<!-- GETTING STARTED --> | ||
## Getting Started | ||
|
||
This is an example of how you may give instructions on setting up your project locally. | ||
To get a local copy up and running follow these simple example steps. | ||
|
||
### Prerequisites | ||
|
||
This is an example of how to list things you need to use the software and how to install them. | ||
* npm | ||
```sh | ||
npm install npm@latest -g | ||
``` | ||
|
||
### Installation | ||
|
||
_Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services._ | ||
|
||
1. Get a free API Key at ... | ||
2. Clone the repo | ||
```sh | ||
git clone ... | ||
``` | ||
3. Install | ||
4. Enter your API ... | ||
|
||
|
||
|
||
<!-- USAGE EXAMPLES --> | ||
## Usage | ||
|
||
Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources. | ||
|
||
_For more examples, please refer to the [Documentation](put URL to documentation here)_ | ||
|
||
|
||
|
||
<!-- CONTRIBUTING --> | ||
## Contributing | ||
|
||
For Contributing please see <a href="./CONTRIBUTING.md">`CONTRIBUTING.md`</a> for more information. | ||
|
||
|
||
|
||
<!-- LICENSE --> | ||
## License | ||
|
||
Distributed under the MIT License. See [`LICENSE.md`](./LICENSE.md) for more information. | ||
|
||
|
||
<!-- MARKDOWN LINKS & IMAGES --> | ||
<!-- https://github.com/kontent-ai/Home/wiki/Checklist-for-publishing-a-new-OS-project#badges--> | ||
[contributors-shield]: https://img.shields.io/github/contributors/kontent-ai/data-ops.svg?style=for-the-badge | ||
[contributors-url]: https://github.com/kontent-ai/repo-template/graphs/contributors | ||
[forks-shield]: https://img.shields.io/github/forks/kontent-ai/data-ops.svg?style=for-the-badge | ||
[forks-url]: https://github.com/kontent-ai/repo-template/network/members | ||
[stars-shield]: https://img.shields.io/github/stars/kontent-ai/data-ops.svg?style=for-the-badge | ||
[stars-url]: https://github.com/kontent-ai/repo-template/stargazers | ||
[issues-shield]: https://img.shields.io/github/issues/kontent-ai/data-ops.svg?style=for-the-badge | ||
[issues-url]:https://github.com/kontent-ai/repo-template/issues | ||
[license-shield]: https://img.shields.io/github/license/kontent-ai/data-ops.svg?style=for-the-badge | ||
[license-url]:https://github.com/kontent-ai/repo-template/blob/master/LICENSE.md | ||
[discussion-shield]: https://img.shields.io/discord/821885171984891914?color=%237289DA&label=Kontent%2Eai%20Discord&logo=discord&style=for-the-badge | ||
[discussion-url]: https://discord.com/invite/SKCxwPtevJ |
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,27 @@ | ||
## Security | ||
In [Kontent.ai](http://kontent.ai/), security has always been of great importance. Kontent.ai is committed to working with security researchers to help identify and fix vulnerabilities in our systems and services, which includes all source code repositories managed through our [GitHub organization](https://github.com/kontent-ai). | ||
|
||
If you believe you have found a security vulnerability in any Kontent.ai-owned repository that meets our [qualification criteria](https://kontent.ai/vulnerability-disclosure-policy/), please report it to us as described below. | ||
|
||
## Reporting Security Issues | ||
**Please do not report security vulnerabilities through public GitHub issues.** | ||
|
||
Security issues and bugs should be reported privately, via email to [[email protected]](mailto:[email protected]). For secure communication, use our [PGP key](https://app.kontent.ai/pgp-key.txt). If you find multiple issues, please report them separately. We will keep you updated on the progress towards remediation of issues we accept from you, and we ask you not to disclose the issue publicly without Kontent.ai’s prior written permission. Additional information can be found in our [Vulnerability Disclosure Policy](https://kontent.ai/vulnerability-disclosure-policy/). | ||
|
||
If possible, please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the issue: | ||
|
||
* Type of issue (e.g. SQL injection, XSS, broken access control…) | ||
* Full paths of source file(s) related to the manifestation of the issue | ||
* The location of the affected source code (tag/branch/commit or direct URL) | ||
* Any special configuration required to reproduce the issue | ||
* Step-by-step instructions to reproduce the issue | ||
* Proof-of-concept or exploit code (if possible) | ||
* Impact of the issue, including how an attacker might exploit the issue | ||
|
||
This information will help us triage your report more quickly. | ||
|
||
## Preferred Languages | ||
We prefer all communications to be in English. | ||
|
||
## Safe harbor | ||
Kontent.ai will not initiate a lawsuit or law enforcement investigation against you in response to reporting a vulnerability if you fully comply with our [Vulnerability Disclosure Policy](https://kontent.ai/vulnerability-disclosure-policy/). |