Skip to content

Conversation

@abachma2
Copy link
Member

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.

@abachma2 abachma2 requested review from gonuke, katyhuff, munkm and nsryan2 May 23, 2025 15:59
@abachma2 abachma2 self-assigned this May 23, 2025
@abachma2 abachma2 added the documentation Improvements or additions to documentation label May 23, 2025
Copy link
Member

@gonuke gonuke left a 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>
Copy link
Member Author

@abachma2 abachma2 left a 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

@abachma2 abachma2 requested a review from gonuke May 23, 2025 19:06
Copy link
Member

@gonuke gonuke left a 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
Copy link
Member

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...

abachma2 and others added 2 commits May 23, 2025 14:19
Co-authored-by: Paul Wilson <paul.wilson@wisc.edu>
Copy link
Member

@nsryan2 nsryan2 left a 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.


![Cyclus logo](https://raw.githubusercontent.com/cyclus/cyclus.github.com/refs/heads/source/source/logos/logo2_bike.gif "Cyclus logo")

The three most-used repositories
Copy link
Member

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.

Copy link
Member Author

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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
CONTRIBUTING, and LICENSE, but some information that is
CONTRIBUTING, and LICENSE file, but some information that is

Copy link
Member Author

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.

@abachma2 abachma2 requested a review from gonuke May 27, 2025 17:49
Copy link
Member

@gonuke gonuke left a 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

@gonuke gonuke merged commit 4ab8598 into cyclus:main May 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants