From 0331828c941d4d9297c604a04339360f5638e9fb Mon Sep 17 00:00:00 2001 From: Aaron Brewster Date: Thu, 7 Nov 2024 11:54:45 -0800 Subject: [PATCH 1/3] Adding CONTRIBUTING.md --- CONTRIBUTING.md | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..6d43be8d99 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,7 @@ +NeXus welcomes contributions. The format is managed by the NeXus international advisory committee (NIAC), but the larger community is vital to continue growing and improving the format. + +We use GitHub issue tracking and pull requests to manage and discuss new features and improvements. The base classes and application definitions in this repository are under under tighter control than the documentation and scripts that build our webpages. For substantive, breaking, or major changes to the NeXus standard, the NIAC will generally need to vote on pull requests (see the [charter](https://www.nexusformat.org/NIAC.html#organization)). For typographical, documentation, or clarification changes, no vote is required. + +Generally for contributions, a GitHub issue should be created that describes a problem and answers "why" there needs to be work done. Then a pull request is created that is the "how" of the fix. The pull request should be suffiently detailed that reviewers can understand the context of the work, and should refer to the original issue. Pull request and commit titles should generally be 50 characters or less to be nicely displayed in various readers. Note, for small fixes, issues are not required, but if the PR is large or if two PRs would solve the same problem differently, add an issue. + +All pull requests need at least one accepting review and to pass the continuous integration checks before they are merged. From 9d22bcdc0524a033750ac45a79e7094f9aa7217b Mon Sep 17 00:00:00 2001 From: Aaron Brewster Date: Thu, 7 Nov 2024 14:09:30 -0800 Subject: [PATCH 2/3] Capitalization --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6d43be8d99..b20d5e44aa 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -NeXus welcomes contributions. The format is managed by the NeXus international advisory committee (NIAC), but the larger community is vital to continue growing and improving the format. +NeXus welcomes contributions. The format is managed by the NeXus International Advisory Committee (NIAC), but the larger community is vital to continue growing and improving the format. We use GitHub issue tracking and pull requests to manage and discuss new features and improvements. The base classes and application definitions in this repository are under under tighter control than the documentation and scripts that build our webpages. For substantive, breaking, or major changes to the NeXus standard, the NIAC will generally need to vote on pull requests (see the [charter](https://www.nexusformat.org/NIAC.html#organization)). For typographical, documentation, or clarification changes, no vote is required. From 8b9945b23b62af578a529855e0231eed1de920b3 Mon Sep 17 00:00:00 2001 From: Aaron Brewster Date: Thu, 7 Nov 2024 16:00:56 -0800 Subject: [PATCH 3/3] Rephrase --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b20d5e44aa..f8a3e37c77 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,6 +2,6 @@ NeXus welcomes contributions. The format is managed by the NeXus International A We use GitHub issue tracking and pull requests to manage and discuss new features and improvements. The base classes and application definitions in this repository are under under tighter control than the documentation and scripts that build our webpages. For substantive, breaking, or major changes to the NeXus standard, the NIAC will generally need to vote on pull requests (see the [charter](https://www.nexusformat.org/NIAC.html#organization)). For typographical, documentation, or clarification changes, no vote is required. -Generally for contributions, a GitHub issue should be created that describes a problem and answers "why" there needs to be work done. Then a pull request is created that is the "how" of the fix. The pull request should be suffiently detailed that reviewers can understand the context of the work, and should refer to the original issue. Pull request and commit titles should generally be 50 characters or less to be nicely displayed in various readers. Note, for small fixes, issues are not required, but if the PR is large or if two PRs would solve the same problem differently, add an issue. +Generally for contributions, a GitHub issue should be created that describes a problem and answers "why" work needs to be done. Then a pull request is created that is the "how" of the fix. The pull request should be suffiently detailed that reviewers can understand the context of the work, and should refer to the original issue. Pull request and commit titles should generally be 50 characters or less to be nicely displayed in various readers. Note, for small fixes, issues are not required, but if the PR is large or if two PRs would solve the same problem differently, add an issue. All pull requests need at least one accepting review and to pass the continuous integration checks before they are merged.