Add a README for the organization #3
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,42 @@ | ||||||
| # Cyclus Organization | ||||||
|
|
||||||
| This organization encompasses the repositories | ||||||
| of and relating to the [Cyclus](https://fuelcycle.org) fuel | ||||||
| cycle simulator code. Cyclus is an agent-based nuclear | ||||||
| fuel cycle simulator. Cyclus is designed to enable a broad | ||||||
| spectrum of fuel cycle simulation, while providing a low | ||||||
| barrier to entry for new users and agent developers. | ||||||
|
|
||||||
|  | ||||||
|
|
||||||
| The three most-used repositories | ||||||
| are: | ||||||
| * Cyclus | ||||||
| * Cycamore | ||||||
| * Cymetric | ||||||
|
|
||||||
| The structure of the organization is: | ||||||
| * The Council of PIs (draft [CEP7](https://github.com/cyclus/cyclus.github.com/pull/296)) | ||||||
| * Community Manager: [Amanda M. Bachmann](https://github.com/abachma2), *insert Community Manager roles* | ||||||
|
|
||||||
| Each repository will have their own README, | ||||||
| CONTRIBUTING, and LICENSE, but some information that is | ||||||
|
Member
There was a problem hiding this comment.
Suggested change
Member
Author
There was a problem hiding this comment. I would say "files" since that describes all three things. If you make that suggestion, I'll commit it and credit you as a co-author. |
||||||
| relevant to all repositories: | ||||||
| * Follow up each of the procedures outlined in the [Cyclus | ||||||
| Enhancement Proposals (CEPs)](https://fuelcycle.org/cep/cep0.html) | ||||||
| * All PRs should address an open issue. If an issue for your | ||||||
| PR does not exist, please make an issue first | ||||||
| * When creating an issue or PR, it can be a: | ||||||
| * Bug: Something is broken in the code and it is not working | ||||||
| as one would expect | ||||||
| * Feature: You are requesting or adding in a new capability | ||||||
| that does not exist in the code currently | ||||||
| * Task: Something that is not a bug or a feature; may be | ||||||
| more administrative in nature, such as updating | ||||||
| documentation. | ||||||
| * The three repositories listed above have a discussions tab, | ||||||
| which is the ideal place to ask questions about installation, | ||||||
| use, suggest ideas, etc. | ||||||
|
|
||||||
| More information about Cyclus and the organization can be | ||||||
| found on the [Cyclus website](https://fuelcycle.org/index.html). | ||||||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it complete to just call them the most-used? We maintain these, as a community, more actively than the other repos in the org.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think "most-used" is accurate, but it's probably not the most descriptive. Any suggestions on what to change it to?