-
Notifications
You must be signed in to change notification settings - Fork 29
Add CONTRIBUTING.md first draft #274
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
Merged
Merged
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
61c792a
Add CONTRIBUTING.md first draft
ktras b2da2d1
Update CONTRIBUTING.MD
ktras 0340683
Update CONTRIBUTING.MD
ktras 502fa50
Update CONTRIBUTING.MD
ktras 0827efa
Update CONTRIBUTING.MD
ktras 17286d2
Fix ORCID image url
ktras 21b60e0
Update CONTRIBUTING.md issue instructions
ktras 8fbe2cf
Fix file extension for CONTRIBUTING.md
ktras 439af53
Update contributors list in CONTRIBUTING.md
ktras File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| Contributing to Fiats | ||
| -------------------------- | ||
|
|
||
| ## Reporting Defects or Suggesting Features | ||
|
|
||
| If you encounter problems or limitations when installing or using Fiats, please do the following: | ||
|
|
||
| 1. Search the Fiats [issues](https://github.com/berkeleylab/fiats/issues), including [closed issues]. | ||
| If your search finds a report of the same problem, please post a comment in the issue. | ||
| 2. Email the Fiats [mailing list](mailto:fortran@lbl.gov) for advice. | ||
| 3. If steps 1 or 2 do not resolve the problem, please file a [new issue] including | ||
| - [ ] The Fortran compiler and compiler version used with Fiats, | ||
| - [ ] The complete output of the build command run with `--verbose` argument, | ||
| - [ ] The Fiats version number or commit hash, | ||
| - [ ] Any conditions required to reproduce the problem such as | ||
| - [ ] The output of `uname -a` showing the operating system (OS), OS version, and processor architecture, | ||
| - [ ] The command used to run your program (e.g., `fpm run ...`), and | ||
| - [ ] Details about the model input file used | ||
|
|
||
| ## Contributing Code or Documentation | ||
|
|
||
| We welcome help with diagnosing, isolating and fixing problems or adding features! | ||
| All contributions are governed by the Fiats [LICENSE.txt](./LICENSE.txt). | ||
| To contribute, please follow these steps: | ||
|
|
||
| - [ ] First please follow the [above steps](#reporting-defects-or-suggesting-features) and include a description of your proposed contribution. | ||
| - [ ] Fork the Fiats repository into your GitHub account | ||
| - [ ] Create a new local branch for your work. | ||
| - [ ] Name your branch according to the issue created. For example `fix-issue-53` or `issue-53-feature`. | ||
| - [ ] Make your commits logically atomic, self-consistent, and cohesive. | ||
| - [ ] Add one or more unit tests in the `test` subdirectory to verify your fix or feature. | ||
| - [ ] Ensure that your branch passes all tests (via `fpm test` with appropriate flags). | ||
| - [ ] Update the [README.md](./README.md) if your branch affects anything described there. | ||
| - [ ] Push your branch to your fork. | ||
| - [ ] Open a [Pull Request](https://github.com/berkeleylab/fiats/pulls) (PR) against an existing branch of the Berkeley Lab [Fiats repository](https://github.com/berkeleylab/fiats). | ||
| - [ ] Please include the corresponding issue number in the PR title. | ||
| - [ ] If your PR is not ready for merging, please click the downward arrow next to the "Create pull request" button and select the "Create draft pull request" option before submitting. | ||
| - [ ] Watch for CI results on your PR and address any failures. | ||
| - [ ] Please be patient and responsive to comments on your PR. | ||
|
|
||
| ## Current and Past Contributors | ||
|
|
||
| Fiats is an open-source project and welcomes community participation in the development process. | ||
| Notable current and past contributors include: | ||
|
|
||
| * [Damian Rouson](https://go.lbl.gov/damian-rouson) | ||
| [@rouson](https://github.com/rouson) | ||
| [![View ORCID record] 0000-0002-2344-868X](https://orcid.org/0000-0002-2344-868X) | ||
|
|
||
| * [Katherine Rasmussen](https://go.lbl.gov/katherine-rasmussen) | ||
| [@ktras](https://github.com/ktras) | ||
| [![View ORCID record] 0000-0001-7974-1853](https://orcid.org/0000-0001-7974-1853) | ||
|
|
||
| * [Dan Bonachea](https://go.lbl.gov/dan-bonachea) | ||
| [@bonachea](https://github.com/bonachea) | ||
| [![View ORCID record] 0000-0002-0724-9349](https://orcid.org/0000-0002-0724-9349) | ||
|
|
||
| * Brad Richardson | ||
| [@everythingfunctional](https://github.com/everythingfunctional) | ||
| [![View ORCID record] 0000-0002-3205-2169](https://orcid.org/0000-0002-3205-2169) | ||
|
|
||
| * Jordan A. Welsman | ||
| [@JordanWelsman](https://github.com/JordanWelsman) | ||
| [![View ORCID record] 0000-0002-2882-594X](https://orcid.org/0000-0002-2882-594X) | ||
|
|
||
| * David Torres | ||
| [@davytorres](https://github.com/davytorres) | ||
| [![View ORCID record] 0000-0003-2469-5284](https://orcid.org/0000-0003-2469-5284) | ||
|
|
||
| * Kareem Weaver | ||
| [@kareem-weaver](https://github.com/kareem-weaver) | ||
| [![View ORCID record] 0009-0009-3846-6248](https://orcid.org/0009-0009-3846-6248) | ||
|
|
||
| You can also browse the [full list of repository contributors](https://github.com/BerkeleyLab/fiats/graphs/contributors). | ||
|
|
||
| --- | ||
|
|
||
| [Long or Frequently Used URLs]: # | ||
| [View ORCID record]: https://github.com/BerkeleyLab/caffeine/wiki/img/ORCID-small.png | ||
| [closed issues]: https://github.com/berkeleylab/fiats/issues?q=is%3Aissue+is%3Aclosed | ||
| [new issue]: https://github.com/berkeleylab/fiats/issues/new | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.