Skip to content

Commit

Permalink
Prep for additional contributors issue #6
Browse files Browse the repository at this point in the history
  Minimal instructions for contributions.
  Provide default structure for feature issues.
  • Loading branch information
grosscol committed Nov 27, 2023
1 parent 57dbb6a commit ce2b20d
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 0 deletions.
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
name: Feature request
about: Feature or change proposal for project
title: ''
labels: ''
assignees: ''

---

## Desired State
A clear and concise description of what you want to happen or the end result.

## Context
A brief description of the current state or rationale for proposing the feature. E.g. a problem or pain point with the project.
30 changes: 30 additions & 0 deletions contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Contributing

## Contributing Code/Features/Bug Fixes
The work on this project roughly follows [git flow](https://datasift.github.io/gitflow/IntroducingGitFlow.html), but without a bugfix or release branch.
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.

1. Make an issue
- Describe the feature or change
- Explain the rationale
- Watch the thread for replies and discussion
1. Make a branch
- Do work on this branch
- Add tests that demonstrate/exercise the expected code use
- Add tests that illustrate expected/known edge cases
1. Create pull request (PR) against develop branch
- Squash commits into single or few related chunks of work.
- Watch the PR thread for replies and discussion
- Watch the PR for continuous integration results

### Commits
Commit messages:

- Written in present tense.
- Answers the question "why?" the code

### Formatting and Linting
For c++ code, use clang-lint and clang-format from LLVM. Configuration will be included in project files.
[](https://github.com/llvm/llvm-project/releases/tag/llvmorg-17.0.5)

For python code, use flake8.

0 comments on commit ce2b20d

Please sign in to comment.