From ce2b20d2a5dd3dc526b8482f897e6c9ed37cf77d Mon Sep 17 00:00:00 2001 From: Colin Gross Date: Mon, 17 Jul 2023 14:17:34 -0400 Subject: [PATCH] Prep for additional contributors issue #6 Minimal instructions for contributions. Provide default structure for feature issues. --- .github/ISSUE_TEMPLATE/feature_request.md | 14 +++++++++++ contributing.md | 30 +++++++++++++++++++++++ 2 files changed, 44 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 contributing.md diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..6f8d7ff --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -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. diff --git a/contributing.md b/contributing.md new file mode 100644 index 0000000..b8bb634 --- /dev/null +++ b/contributing.md @@ -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.