Palladio Github Repository Template
Naming
TODO: define and add topics
Topics
TODO: define and add topics
Meta-Data
The meta-data consists of a description and an URL. The description should be a short version of the description used in the README.md file. The URL should point to the corresponding wiki page.
Features
We do not use anything in the category Features, so immediately disable all points. We do not use these features because we document our addons in our wiki and track issues in our JIRA instance.
We allow all types of merges, so keep all options checked.
Branches
We do not allow commits to master without proper code review. Therefore, we have to create a branch protection rule. Go to Branches and use the Add rule button to create a new rule. Use the following template for creating the rule:
| Option | Value |
|---|---|
| Apply rule to | master |
| Require pull request reviews before merging | ☒ |
| Required approving reviews | 1 |
| Dismiss stale pull request approvals when new commits are pushed | ☒ |
| Require review from Code Owners | ☐ |
| Restrict who can dismiss pull request reviews | ☐ |
| Require status checks to pass before merging | ☐ |
| Require signed commits | ☐ |
| Include administrators | ☒ |
| Restrict who can push to matching branches | ☐ |
Default Content
Every repository has to contain a LICENSE and a README.md file. The license has to be either EPL for Palladio contributions or Apache for build system contributions available via Maven Central.
The readme file has to adhere to the following template:
# Project name Short project description (might be copied from the addon description in our wiki) ## Documentation For comprehensive documentation, please visit our [wiki page](https://sdqweb.ipd.kit.edu/wiki/Palladio_xyz). ## Support For support * visit our [issue tracking system](https://palladio-simulator.com/jira) * contact us via our [mailing list](https://lists.ira.uni-karlsruhe.de/mailman/listinfo/palladio-dev) For professional support, please fill in our [contact form](http://www.palladio-simulator.com/about_palladio/support/).