Skip to content

Commit

Permalink
Create core-class-template.md
Browse files Browse the repository at this point in the history
  • Loading branch information
bobluppes authored Dec 1, 2024
1 parent ec9e0b0 commit c5ff7a3
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/core-class-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
name: Core Class Template
about: Template used for new core classes in the Graaf library.
title: "[CORE]"
labels: enhancement
assignees: ''

---

# [CLASS_NAME]
A short description of what the class does and it's common use cases.

## Syntax
An initial idea for the (public) interface of the new class is as follows:<br>
_(note that this is not set in store and merely serves as a starting point)_

```c++
class my_class {
public:
//...
}
```
This class should live in the `graaf` namespace under `include/graaflib/`.
## Definition of Done
This issue is done when:
- [ ] The new class is implemented
- [ ] The new class has a javadoc-style comment for the entire class and for the public methods
- [ ] Appropriate tests are added under `test/graaflib/algorithm`
- [ ] A test coverage of at least 95% is reached

0 comments on commit c5ff7a3

Please sign in to comment.