Add more context to the README #29
Merged
Conversation
This file contains 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
cd-work
reviewed
May 2, 2023
louislang
previously requested changes
May 2, 2023
maxrake
reviewed
May 3, 2023
There was a problem hiding this comment.
Some additional suggestions:
- The Phylum website already talks about Birdcage
- There is a logo used there that could/should also be used here
- A link to https://www.phylum.io/defend-developers could be included here somewhere
- Complete the last two items on the Community Standards "checklist"
- Contributing guide
- Issue templates
- Some badges might help to make things look "shinier"
- Here is the rendered form:
- And here is a copy/paste form:
[][license]
[][issues]
[][CoC]
[][discord_invite]
[license]: https://github.com/phylum-dev/birdcage/blob/main/LICENSE
[issues]: https://github.com/phylum-dev/birdcage/issues
[CoC]: https://github.com/phylum-dev/birdcage/blob/main/CODE_OF_CONDUCT.md
[discord_invite]: https://discord.gg/Fe6pr5eW6p
First time I saw this logo now and it's amazing. Should definitely go in the repo too. |
Co-authored-by: Christian Dürr <102963075+cd-work@users.noreply.github.com>
kylewillmon
commented
May 3, 2023
assets/Birdcage.png
Outdated
There was a problem hiding this comment.
This is 50% scale from the original because it looks better in the README
I could have scaled it by using an <img /> tag with height or width, but then I would have to use an absolute path to the image. It seemed simpler to scale the image manually so that I can just use the markdown ![]() syntax with a relative path.
maxrake
requested changes
May 3, 2023
Co-authored-by: Charles Coggins <maxrake@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Update some language and add details about the history of Birdcage and the technologies that are used.
See the rendered version