Add CONTRIBUTING.md and Contributing Section to README.md #4539
Conversation
CONTRIBUTING.md
Outdated
|
|
||
| - **[Development Environment Setup Guide](https://github.com/fedimint/fedimint/blob/master/docs/contributing.md)**: Follow this guide to set up your development environment. | ||
|
|
||
| If you have any questions, don't hesitate to reach out to us on our [Developer Discord](https://chat.fedimint.org). Our community is friendly and supportive, and we're here to help you succeed. |
There was a problem hiding this comment.
Should we have a channel dedicated to new contributors or is general good enough for it?
There was a problem hiding this comment.
just update that link so they land on that channel specifically then it's good
There was a problem hiding this comment.
I've refreshed the link with a new invitation that I just created from the #new-contributors channel.
CONTRIBUTING.md
Outdated
|
|
||
| Welcome to the Fedimint project! We're thrilled that you're interested in contributing to our open-source community. Below are some resources to help you get started: | ||
|
|
||
| - **[Contributing Guidelines](https://github.com/fedimint/fedimint/blob/master/docs/contributing.md)**: Read our guidelines to understand how you can contribute to Fedimint. |
There was a problem hiding this comment.
Let's not have this file link to itself
There was a problem hiding this comment.
The document mentioned is in a different folder from the CONTRIBUTING.md file in the main repository.
There was a problem hiding this comment.
just move the contributing.md out of the docs folder into this root, link to it from the readme, and update the instructions to new contributors to include what I put in the discord under the new-contributors channel
There was a problem hiding this comment.
Afaik having it in the root is better anyway since GitHub can detect it and might have some current or future integrations with it.
CONTRIBUTING.md
Outdated
|
|
||
| - **[Development Environment Setup Guide](https://github.com/fedimint/fedimint/blob/master/docs/dev-env.md)**: Follow this guide to set up your development environment. | ||
|
|
||
| If you have any questions, don't hesitate to reach out to us on our [Developer Discord](https://discord.gg/BGFMXSkNJW). Our community is friendly and supportive, and we're here to help you succeed. |
There was a problem hiding this comment.
Is this a special link that leads directly into a channel? Otherwise I'd propose using https://chat.fedimint.org, which is easier to change should we ever need a new invite link.
There was a problem hiding this comment.
that link leads directly to #new-contributors channel
while the https://chat.fedimint.org leads to general
|
Everybody got to point out their nits and wishes, don't be afraid to ping me and other directly when addresses and it's squashed. Let's land it soon, as it's a solid improvement, will not break anything one way or the other, so no need to keep it in progress for too long. |
In this pull request, I have made improvements to the main repository by adding a CONTRIBUTING.md file and updating the main README.md to include a small section for contributing.