From 05bf4daebe2c4026ffc356ec858bb338af864a93 Mon Sep 17 00:00:00 2001 From: Philip Cook Date: Tue, 6 Jun 2023 15:31:57 -0400 Subject: [PATCH 1/4] WIP: Add CONTRIBUTING.md --- CONTRIBUTING.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..d41a54fec --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,29 @@ +# Contributing to ANTs + +Contributions to ANTs are welcome. The developers are grateful to the many contributors to ANTs, both those who have [contributed to the ANTs source code](https://github.com/ANTsX/ANTs/graphs/contributors) and those who have contributed time, testing, feedback and ideas. + +## Contributing code + +### 1. Plan contribution with ANTs team + +Before doing a lot of work, we recommend that you open an issue or start a discussion thread to discuss your ideas. If fixing a bug, please identify the bug in an issue first, following the bug report template. + +### 2. Make changes and test locally + +Once your code compiles without error and runs satisfactorily, you can open a pull request. You can mention issues by their number, eg `See issue #1234`. If you're confident that you're completing an open issue, you can say `Fixes #1234`, this will close the associated issue when the PR is merged. + +### 3. Open a pull request + +All contributions must be made via pull request on a fork of the ANTs repository. The developers will review and give feedback. + +Write your commit messages using the standard prefixes for ITK commit messages: + +* BUG: Fix for runtime crash or incorrect result +* COMP: Compiler error or warning fix +* DOC: Documentation change +* ENH: New functionality +* PERF: Performance improvement +* STYLE: No logic impact (indentation, comments) +* WIP: Work In Progress not ready for merge + +A Github continuous integration test will be run on the PR, confirming that it compiles on Linux and doesn't break basic functionality. This is a minimal test From a95f21af2a158d873b04b3b1ab9425e178b5c70e Mon Sep 17 00:00:00 2001 From: Philip Cook Date: Tue, 6 Jun 2023 16:51:25 -0400 Subject: [PATCH 2/4] Update CONTRIBUTING.md --- CONTRIBUTING.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d41a54fec..6c2cd59d7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -26,4 +26,9 @@ Write your commit messages using the standard prefixes for ITK commit messages: * STYLE: No logic impact (indentation, comments) * WIP: Work In Progress not ready for merge -A Github continuous integration test will be run on the PR, confirming that it compiles on Linux and doesn't break basic functionality. This is a minimal test +A Github continuous integration test will be run on the PR, confirming that it compiles on Linux and doesn't break basic functionality. This is a minimal test, please test new functionality and if at all possible do so on open data, so that the developers can reproduce results. + + +### Licensing of contributions + +All accepted contributions will be incorporated into the ANTs source code and distributed according to the terms of the ANTs license. From 140b229533e315cec3a446a5468499f82ce2c921 Mon Sep 17 00:00:00 2001 From: Philip Cook Date: Tue, 6 Jun 2023 16:52:25 -0400 Subject: [PATCH 3/4] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6c2cd59d7..7ff359300 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,7 +24,7 @@ Write your commit messages using the standard prefixes for ITK commit messages: * ENH: New functionality * PERF: Performance improvement * STYLE: No logic impact (indentation, comments) -* WIP: Work In Progress not ready for merge +* WIP: Work In Progress not ready for merge (used before PR is ready, or if a draft PR needs feedback or assistance) A Github continuous integration test will be run on the PR, confirming that it compiles on Linux and doesn't break basic functionality. This is a minimal test, please test new functionality and if at all possible do so on open data, so that the developers can reproduce results. From 6c49fc46b937249da652f1371a5e30b377bd8538 Mon Sep 17 00:00:00 2001 From: Philip Cook Date: Tue, 6 Jun 2023 20:43:19 -0400 Subject: [PATCH 4/4] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7ff359300..947497f12 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contributing to ANTs -Contributions to ANTs are welcome. The developers are grateful to the many contributors to ANTs, both those who have [contributed to the ANTs source code](https://github.com/ANTsX/ANTs/graphs/contributors) and those who have contributed time, testing, feedback and ideas. +Contributions to ANTs are welcome. The developers are grateful to the many contributors to ANTs, both those who have [contributed to the ANTs source code](https://github.com/ANTsX/ANTs/graphs/contributors) and those who have contributed documentation, testing, feedback and ideas. ## Contributing code