Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
---
name: Bug report
about: Create a report and help improving this project
title: 'Network Generator Bug Report'
about: Create a Bug Report and help improving Kebab Krafter.
title: '[BUG] Kebab Krafter Bug Report'
labels: 'bug'
---

**Describe the bug**
**Describe the Bug**

Describe the bug in a clear and concise way. Add screenshots if available.

**Reproduce steps**
**Steps to reproduce the Bug**

Describe all steps to reproduce the behavior:
Describe all required steps to reproduce the buggy behavior:
1. Go to '...'
2. Click on '....'
2. Tap on '....'
3. Scroll down to '....'
4. See error

Expand All @@ -28,3 +28,5 @@ If applicable, add screenshots to help explain your problem.
**Additional context**

Give additional context like runtime environment, versions, cloud provider, etc.

**✓ - I have checked open and closed issues before opening this report, and my bug is not listed.**
7 changes: 4 additions & 3 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
---
name: Feature request
about: Add your feature request
title: 'Network Generator Feature Request'
about: Create a Feature request and help improving Kebab Krafter.
title: '[FEATURE] Kebab Krafter Feature Request'
labels: 'feature'

---

**Is your feature request related to a problem? Please describe.**
Expand All @@ -24,3 +23,5 @@ Are there any alternatives? Pleaes describe them.
**Additional context**

Add screenshots, scribbles, or any other context to describe this feature request.

**✓ - I have checked open and closed feature requests before opening this issue, and my feature is not listed.**
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/security_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
name: Security report
about: Create a Security issue and help improving Kebab Krafter.
title: '[SECURITY] Kebab Krafter Security Issue'
labels: 'secrurity'
---

**Describe the security issue**

Describe the security issue in a clear and concise way. Add screenshots and log reports if available.

**Issued software version of Kebab Krafter**

Provide the exact software version where the issue occurs.
Please also give additonal information about your dependency stack if possible.

**Additional context**

Give additional context like runtime environment, cloud provider, network conditions etc.

**Screenshots**

If applicable, add screenshots to help explain your problem.

**✓ - I have checked open and closed issues before opening this report, and my security problem is not listed.**
27 changes: 8 additions & 19 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,18 @@
# Changelog
All notable changes to this project will be documented in this file.
Changes and new functionality.



## [Unreleased] - yyyy-mm-dd


### Added
- [TICKET-n](http://tickets.diconium.com/browse/TICKET-n)
MINOR tickets or PATCH tickets

### Changed
- [TICKET-n](http://tickets.diconium.com/browse/TICKET-n)
CHANGES

### Fixed
- [TICKET-n](http://tickets.diconium.com/browse/TICKET-n)
FIXES
## [0.0.9] - 2024-05-07
## [initial-release] - 2024-09-14

### Added
- readme, templates and documentation
- Kebab Krafter initial

### Changed
- (none)

### Fixed
- (none)
- (none)

---


6 changes: 6 additions & 0 deletions CODING_GUIDELINES.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Coding Guidelines


## ---> TODO: @ronaldo


----
_______ example content
- You can validate that your code complies with these guidelines by running `stuff/php-format.py validate`
- Tabs, no spaces
- End of line should should be Unix style (`\n`), not Windows style (`\r\n`)
Expand Down
55 changes: 51 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,61 @@
# Contributing Guide

- Contributing to KEBAB-KRAFTER is fairly easy. This document shows you how to get started.
- Contributing to <b>Kebab Krafter</b> is fairly easy. This document shows you how to get started.

# TODO --> content!

example: [RUBY ON RAILS](https://github.com/rails/rails/blob/main/CONTRIBUTING.md)

## Table of Contents

- [Bug Report](#reporting-a-bug)
- [Feature Request](#requesting-a-new-feature)
- [Security Issue](#reporting-a-security-issue)
- [Submitting Changes](#submitting-changes)
- [Becoming Contributor](#becoming-contributor)


## General
- The [documentation guide](https://docs) is the ideal beginner to explore the project and to get started.
Kebab Krafter highly welcomes contributors!

For code contribution, simply checkout this repository and add your code with a new Pull request.

For reporting issues or requesting new features, please use the templates described below.


## Reporting a Bug

Bugs are reported as issues.

Issue creation uses predefined templates to help you gathering all required information.

When reporting bugs, don't forget to add code examples, and detailled information of time and environment during bug appearence.

## Requesting a new Feature

New features also use issue templates, similar to bug reports.

For new feature requests, open a new issue and fill out the corresponding template with required information.


## Reporting a security issue

Security is important and gets maximum attention.

If you find a security related problem with Kebab Krafter, open a new issue and use the security template to share detailled information.

Kebab Krafter is Open Source Software under Apache license. The authors and contributors are not responsible for damages or problems resulting of any security issue, reported or unknown. Be a hero and help hardening Kebab Krafter with your code contribution.


## Becoming Contributor

<i><b>! TODO</i></b>


## Submitting changes

- Fork this repo
- <https://github.com/diconium/mcc-network-generator/fork>
- <https://github.com/diconium/kebab-krafter/fork>
- Check out a new branch base and name it to what you intend to do:
- Example:
````
Expand All @@ -21,7 +68,7 @@
- Use one branch per fix / feature
- Commit your changes
- Please provide a git message that explains what you've done
- Please make sure your commits follow the [conventions](https://github.com/diconium/mcc-network-generator/CONTRIBUTING.md#commit-messages)
- Please make sure your commits follow the [conventions](https://github.com/diconium/kebab-krafter/CONTRIBUTING.md#commit-messages)
- Commit to the forked repository
- Example:
````
Expand Down
1 change: 0 additions & 1 deletion LICENSE_GUIDELINES.md

This file was deleted.

Loading