Create CONTRIBUTING.md #239
Conversation
|
Published docs preview URL: https://devrev-preview-e41e80a8-ba79-4d3e-b347-074fea9b85aa.docs.buildwithfern.com |
|
|
||
| Any contribution you make can be made to the code located in this repository. In order to contribute, you'll need to start off of a local version of this repository. | ||
|
|
||
| #### 1. Fork the repository |
There was a problem hiding this comment.
@nimit2801 and others have had troubles deploying changes from forks. Has it been confirmed that forking works?
Also, H4s are typically not a good idea. Headings are not required here--a numbered list is adequate.
|
|
||
| ### Create a new issue | ||
|
|
||
| If you spot a problem within a repository, [search if an issue already exists](https://docs.github.com/en/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests#search-by-the-title-body-or-comments). If a related issue doesn't exist, you can open a new issue here!Please make sure any added issues are |
There was a problem hiding this comment.
Is there supposed to be a link in here? This type of construction is not recommended. https://learn.microsoft.com/en-us/style-guide/urls-web-addresses#grammar-and-formatting
|
|
||
| Thank you for investing your time in contributing to DevRev's documentation. Any contribution you make will be reviewed by our team. In this guide, you'll learn the different ways you can contribute. | ||
|
|
||
| ### Create a new issue |
There was a problem hiding this comment.
I'd recommend getting rid of this heading and the next one. Rather than highlighting the two possibilities it buries them.
| > _For help, support, feature requests, and product questions - head to our [DevRev's Discord Community](https://discord.gg/c6JuJAT4Aa)🤖_ | ||
|
|
||
| Thank you for investing your time in contributing to DevRev's documentation. Any contribution you make will be reviewed by our team. In this guide, you'll learn the different ways you can contribute. | ||
|
|
There was a problem hiding this comment.
It would be a good idea to include a TOC for the page since it's not rendered on a web site.
Co-authored-by: Ben Colborn <[email protected]>
Co-authored-by: Ben Colborn <[email protected]>
Co-authored-by: Ben Colborn <[email protected]>
Co-authored-by: Ben Colborn <[email protected]>
|
Published docs preview URL: https://devrev-preview-07919157-3545-4e1e-883b-e65f03be8ccf.docs.buildwithfern.com |
|
Published docs preview URL: https://devrev-preview-9ecac200-75b4-41e8-bb71-d0f46b5df774.docs.buildwithfern.com |
|
Published docs preview URL: https://devrev-preview-6475603f-b152-4887-8689-21045298fb13.docs.buildwithfern.com |
🌟 EkLine ReviewerHello! I’m here to help improve your docs. I’ve reviewed your pull request, and left in-line suggestions for quick fixes. For details, visit the Analytics Page. For questions or feedback, please email [email protected]. |
|
Published docs preview URL: https://devrev-preview-90195c84-52a5-4718-bc25-038faf8c2679.docs.buildwithfern.com |
ISS-177444