Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding CONTRIBUTING.md #1509

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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" 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.
Loading