Skip to content

Commit 7209c08

Browse files
committed
Issue #6. Prep for additional contributors.
Minimal instructions for contributions. Provide default structure for feature issues.
1 parent 57dbb6a commit 7209c08

File tree

2 files changed

+44
-0
lines changed

2 files changed

+44
-0
lines changed
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: Feature request
3+
about: Feature or change proposal for project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
## Desired State
11+
A clear and concise description of what you want to happen or the end result.
12+
13+
## Context
14+
A brief description of the current state or rationale for proposing the feature. E.g. a problem or pain point with the project.

contributing.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Contributing
2+
3+
## Contributing Code/Features/Bug Fixes
4+
The work on this project roughly follows [git flow](https://datasift.github.io/gitflow/IntroducingGitFlow.html), but without a bugfix or release branch.
5+
In short, work is laid out in an issue, done in a feature branch, tested in the develop branch, and finally added to the main branch.
6+
7+
1. Make an issue
8+
- Describe the feature or change
9+
- Explain the rationale
10+
- Watch the thread for replies and discussion
11+
1. Make a branch
12+
- Do work on this branch
13+
- Add tests that demonstrate/exercise the expected code use
14+
- Add tests that illustrate expected/known edge cases
15+
1. Create pull request (PR) against develop branch
16+
- Squash commits into single or few related chunks of work.
17+
- Watch the PR thread for replies and discussion
18+
- Watch the PR for continuous integration results
19+
20+
### Commits
21+
Commit messages:
22+
23+
- Written in present tense.
24+
- Answers the question "why?" the code
25+
26+
### Formatting and Linting
27+
For c++ code, use clang-lint and clang-format from LLVM. Configuration will be included in project files.
28+
[](https://github.com/llvm/llvm-project/releases/tag/llvmorg-17.0.5)
29+
30+
For python code, use flake8.

0 commit comments

Comments
 (0)