https://github.com/kentico/repo-template
This is a template for new repositories in the Kentico organization.
https://github.com/kentico/repo-template
private-repository template-repository
Last synced: 6 months ago
JSON representation
This is a template for new repositories in the Kentico organization.
- Host: GitHub
- URL: https://github.com/kentico/repo-template
- Owner: Kentico
- License: mit
- Created: 2020-03-13T10:36:44.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-12-16T09:46:44.000Z (10 months ago)
- Last Synced: 2025-04-12T19:09:19.224Z (6 months ago)
- Topics: private-repository, template-repository
- Language: PowerShell
- Size: 82 KB
- Stars: 2
- Watchers: 19
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: docs/Contributing-Setup.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
## ---Template info---
---Run the `Repository-Setup.ps1` in the root of this repository, specifying the `ProjectName` for the new project
---ex: `.\Repository-Setup.ps1 -ProjectName Kentico.Xperience.CoolProject`
---This section contains general information about the repository template and is to be deleted before submitting a pull request with the final documentation.---
---Lines enclosed by three dashes (like this one) are placeholders and comments to be replaced with specific information or deleted completely.---
### ---Library naming conventions---
---Repository name – use "xperience-by-kentico-\" for projects aimed for Xperience by Kentico and "xperience-\" for projects aimed for Kentico Xperience 13---
---Package Name – use "Xperience by Kentico: \" for projects aimed for Xperience by Kentico and "Xperience: \" for projects aimed for Kentico Xperience 13---
# ---Package Name---
---Select the correct badge for the support policy and update the GitHub Action pipeline badge to point to this repository (replace `repo-template`)---
[](https://github.com/Kentico/.github/blob/main/SUPPORT.md#full-support) [](https://github.com/Kentico/.github/blob/main/SUPPORT.md#labs-limited-support) [](https://github.com/Kentico/repo-template/actions/workflows/ci.yml)
## Description
---A short description of the functionality – what scenarios are fulfilled by the Intergration / App / Solution. Include screenshots displaying the functionality.---
---Also list any limitations of the functionality that may result in unexpected behavior for the end user. These can be caused, e.g., by scope cuts or unexpected issues during implementation.---
## Requirements
### Library Version Matrix
---This matrix explains which versions of the library are compatible with different versions of Xperience by Kentico / Kentico Xperience 13---
| Xperience Version | Library Version |
| ----------------- | --------------- |
| >= 28.1.0 | 1.0.0 |
### Dependencies
---These are all the dependencies required to use (not build) the library---
- [ASP.NET Core 8.0](https://dotnet.microsoft.com/en-us/download)
- [Xperience by Kentico](https://docs.kentico.com)
### Other requirements
---A list of other requirements and prerequisites needed to use the library. If there are none, don't include this section in the readme.---
## Package Installation
---This details the steps required to add the library to a solution. This could include multiple packages (NuGet and/or npm)---
Add the package to your application using the .NET CLI
```powershell
dotnet add package
```
## Quick Start
---Minimal steps to get started with the library. Support the steps with helpful screenshots.---
---You can completely omit this section if the setup is complicated and cannot be realistically condensed into a few steps. Instead, describe everything in detail in _Usage-Guide.md_.---
## Full Instructions
---Add the full instructions, guidance, and tips to the _Usage-Guide.md_ file---
View the [Usage Guide](./docs/Usage-Guide.md) for more detailed instructions.
## Contributing
To see the guidelines for Contributing to Kentico open source software, please see [Kentico's `CONTRIBUTING.md`](https://github.com/Kentico/.github/blob/main/CONTRIBUTING.md) for more information and follow the [Kentico's `CODE_OF_CONDUCT`](https://github.com/Kentico/.github/blob/main/CODE_OF_CONDUCT.md).
Instructions and technical details for contributing to **this** project can be found in [Contributing Setup](./docs/Contributing-Setup.md).
## License
Distributed under the MIT License. See [`LICENSE.md`](./LICENSE.md) for more information.
## Support
---Select the correct badge for the support policy---
[](https://github.com/Kentico/.github/blob/main/SUPPORT.md#full-support) [](https://github.com/Kentico/.github/blob/main/SUPPORT.md#labs-limited-support)
---Select the correct name for the support policy---
This project has **Full support by 7-day bug-fix policy** / **Kentico Labs limited support**.
See [`SUPPORT.md`](https://github.com/Kentico/.github/blob/main/SUPPORT.md#full-support) for more information.
For any security issues see [`SECURITY.md`](https://github.com/Kentico/.github/blob/main/SECURITY.md).