Kompakkt / Kompakkt/Documentation
Issue and Feature Guidelines
- Dominant language
- No language data
- Stars
- 5
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
### How do I write an Issue?
If you have an issue with any of the Kompakkt related services (Repo, Viewer, Server or anything else), try to comply with these guidelines to make life for our developers easier.
### What should I include in my issue?
You can choose to add more, but try to add the following:
- [x] What
General Explanation of the issue, what you are trying to do and what you expected the application to do.
- [x] Where
Page or part of Kompakkt where the issue occurs. If you are not sure where the issue might be coming from, feel free to include a URL.
- [ ] Screenshot
Attach a screenshot of the issue if you can.
- [x] Console Output
If the issue is about anything that impacts usage of Kompakkt services but has no apparent root cause, either try to include the console output of the developer console of your browser or a screenshot of the developer console.
### Template
```markdown
### What
Explain your issue
### Where
Where did the issue occur?
Page with the issue: [Click here](https://kompakkt.de/)
### Screenshot
Drag a screenshot here
### Console Output
Use the "Insert Code" button at the top of the editor and insert code between the backward ticks -> `
```
### How do I write a Feature Request?
If there is a feature missing in Kompakkt that would enhance the functionality of the Kompakkt related services, try to stick to the following guidelines.
### What should I include in my Feature Request?
You can choose to add more, but try to add the following:
- [ ] What
Detailed Explanation of the Feature you would like to see.
- [ ] Why
What is the motivation of your request and how would you use the feature.
- [ ] Mockup
If you are able to, provide mockup images of how the feature could look or where you would expect the feature on the page
### Template
```markdown
### What
Explain your feature request
### Why
Why the feature is needed and how you would use it
### Mockup
Drag images here
```
Contributor guide
No contributing guide indexed for this repository
Research direction
The issue body is the only referenced artifact; start by reviewing its issue and feature request guidelines and templates. The issue does not identify a documentation change, file, or test, so completion cannot be verified until the intended update and its acceptance criteria are specified.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100