-
Notifications
You must be signed in to change notification settings - Fork 3
Add a README for the organization #3
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
Changes from 6 commits
6ad92e7
bf20191
075f82c
92e5a5f
8c21127
dbbb785
961a6e1
1234382
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| 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 | ||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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.
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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? |
||||||
| 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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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). | ||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. If the above suggestion works, then we don't need this file... |
Uh oh!
There was an error while loading. Please reload this page.