-
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
Conversation
gonuke
left a comment
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.
A few top-level things. Also, do we want graphics/logo?
Co-authored-by: Paul Wilson <paul.wilson@wisc.edu>
abachma2
left a comment
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.
Thanks for the feedback, @gonuke. I'll change the document to markdown, add in the Cyclus graphic, and add a little more context for the purpose of Cyclus
gonuke
left a comment
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.
Proposal to use an existing logo file rather than include a new copy
logo2.png
Outdated
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.
If the above suggestion works, then we don't need this file...
Co-authored-by: Paul Wilson <paul.wilson@wisc.edu>
nsryan2
left a comment
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 this is a good, concise readme! Thanks for getting this done. I have a small question and suggestion, but nothing that would prevent merging.
|
|
||
|  | ||
|
|
||
| The three most-used repositories |
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?
| * 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 |
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.
| CONTRIBUTING, and LICENSE, but some information that is | |
| CONTRIBUTING, and LICENSE file, but some information that is |
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 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.
gonuke
left a comment
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.
LGTM - let's get this in place and modify as needed in the future. Thanks @abachma2
This PR adds a README for the Cyclus organization. This README would display on the Cyclus organization page, therefore it is generic. This PR is prompted by some discussions I had with @gonuke in #2 and on slack.
Note: I added in a section about some of the community structure (hierarchy?), but it is based on an open PR for CEP 7. I also put in a point about the community manager, and I have not been able to find a description of this role to put in this document. We can remove this information until that PR is merged.