-
Notifications
You must be signed in to change notification settings - Fork 7
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
Updates to the readme and adding badges #48
base: main
Are you sure you want to change the base?
Conversation
***THIS IS A DRAFT PR.*** This is an update to our org README with badges and such to make it easier for people to get around and find things. It needs some more updates but it's getting there.
@kaosine This Draft PR has been open for quite some time, are we planning any more work or is it safe to close this for the time being? |
Well it was waiting on feedback and improvements that it never got. I had it open for this reason as a draft. |
I wonder if we should have a common template for all Pulsar repos (at least the main ones) with a specific section for that repo? |
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.
So looking at this, there's still some obvious parts that are in progress, but here's some points.
- We do need to make sure our contact use section is filled out
- Do we want to have a full contact us section if we are also using badges at the top that link to the same locations?
- We should likely get this updated after the overhaul of our Readme on Pulsar since it seems to be trying to mimic it's style
- Update the image with the new one used on Pulsar, likely linking to the exact same source or also brining that image into this repo.
- Remove the brand guidelines badge and link, as those are GitHub's guidelines and not ours
- We also should probably update the section that says
into the 21-st century
with the new description that's been updated elsewhere, I think our privacy policy found a really good way to say this without being a dis-service to Atom. - I'd personally like to see the contact us and links section before the image. As for me at least, the image doesn't represent the whole org. Sure it represents the major project within the org, but as the org level readme there's a lot more to cover so doesn't feel the image is our highest priority thing to show off, but others might disagree
Well, changes can be requested in code. If you'd like to add that, it would help tremendously, since I'm not sure what to add. With some of the specifics on contact other than links to all our socials if it's still viable to port back changes and update this. Since I know we wanted to clearly label things and make sure all the info was up to date. |
THIS IS A DRAFT PR.
This is an update to our org README with badges and such to make it easier for people to get around and find things. It needs some more updates but it's getting there.