Skip to content
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

chore(README): add contributing section to readme #13059

Merged
merged 2 commits into from
Apr 24, 2024

Conversation

doodzik
Copy link
Contributor

@doodzik doodzik commented Apr 23, 2024

Finding the contributing manual to set up the repository so I could run make fmt was a bit annoying. I expect an open-source repo to have a section in the readme. To address this issue, I added a link to the contributing documentation in the readme.

@cdr-bot cdr-bot bot added the community Pull Requests created by the community. label Apr 23, 2024
@doodzik doodzik changed the title chore(docs): add contributing section to readme chore(README): add contributing section to readme Apr 23, 2024
Copy link
Member

@ericpaulsen ericpaulsen left a comment

Choose a reason for hiding this comment

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

Great callout - our contributing docs are admittedly hard to find.

Copy link
Member

@kylecarbs kylecarbs left a comment

Choose a reason for hiding this comment

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

We used to have this section, but I felt like it detracted a bit from others.

I'd be in favor of this going in the bottom of the README, so it's at least Ctrl+F-able.

@doodzik
Copy link
Contributor Author

doodzik commented Apr 23, 2024

I'd be in favor of this going in the bottom of the README, so it's at least Ctrl+F-able.

Sounds good. This is exactly what I did to figure out how to contribute.

@doodzik doodzik requested a review from kylecarbs April 23, 2024 23:20
@matifali matifali merged commit a6af7a5 into coder:main Apr 24, 2024
22 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Apr 24, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
community Pull Requests created by the community.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants