-
Notifications
You must be signed in to change notification settings - Fork 3
Create CONTRIBUTING.md #239
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
base: main
Are you sure you want to change the base?
Changes from all commits
235e2f5
8bfe923
e4f340e
56eced4
dc55d45
eebc009
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,84 @@ | ||
# Welcome to DevRev developer docs contributing guide! | ||
|
||
> _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. | ||
|
||
### Create a new issue | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'd recommend getting rid of this heading and the next one. Rather than highlighting the two possibilities it buries them. |
||
|
||
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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is there supposed to be a link in |
||
|
||
- Descriptive | ||
- Thoughtful | ||
- Organized | ||
|
||
Include as many relevant links, minimal reproductions of the issue, and other materials that will help our team solve the issue fast. | ||
|
||
### Solve an issue | ||
|
||
If you're interested in solving an issue in our repository, start by scanning through existing issues to find one that you're interested in working on. If you find an issue to work on, you are welcome to open a PR with a fix. See the following sections below for more information on contributing for specific sections. | ||
|
||
## Contributing | ||
|
||
### Make changes locally | ||
|
||
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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @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. |
||
|
||
##### Using GitHub Desktop: | ||
|
||
- [Getting started with GitHub Desktop](https://docs.github.com/en/desktop/installing-and-configuring-github-desktop/getting-started-with-github-desktop) will guide you through setting up Desktop. | ||
- Once Desktop is set up, you can use it to [fork the repo](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/cloning-and-forking-repositories-from-github-desktop)! | ||
|
||
##### Using the command line: | ||
|
||
- [Fork the repo](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#fork-an-example-repository) so that you can make your changes without affecting the original project until you're ready to merge them. | ||
|
||
#### 2. Create a working branch and start with your changes | ||
|
||
After forking this repository, you'll want to [create a branch](https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-a-branch-for-an-issue) to work off of. | ||
|
||
#### 3. Install dependencies and run the project locally | ||
|
||
``` | ||
npm install -g fern-api | ||
``` | ||
|
||
#### 4. Make your changes in the files/add new files | ||
Once you make changes, run to preview your changes locally | ||
``` | ||
fern docs dev | ||
``` | ||
You can also create a PR and get a unique preview link in your PR. | ||
|
||
### Commit your update | ||
|
||
[Commit your changes](https://github.com/git-guides/git-commit) once you are happy with them. See [Atom's contributing guide](https://github.com/atom/atom/blob/master/CONTRIBUTING.md#git-commit-messages) to know how to use emoji for commit messages! | ||
|
||
Once your changes are ready, don't forget to self-review your code to double check that your chagnes are ready to be added. | ||
|
||
### Pull Request | ||
|
||
When you're finished with the changes, [create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request), also known as a PR. | ||
|
||
- Don't forget to [link PR to issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) if you are solving one. | ||
- Once you submit your PR, a DevRev's team member will review your proposal. We may ask questions or request additional information. | ||
- We may ask for changes to be made before a PR can be merged, either using [suggested changes](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request) or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch. | ||
- As you update your PR and apply changes, mark each conversation as [resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations). | ||
- If you run into any merge issues, checkout this [git tutorial](https://lab.github.com/githubtraining/managing-merge-conflicts) to help you resolve merge conflicts and other issues. | ||
|
||
### Your PR is merged | ||
|
||
Congratulations 🎉 Thank you for your contribution! Once your PR is merged, your contributions will be publicly visible on the relevant repository. | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
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.
It would be a good idea to include a TOC for the page since it's not rendered on a web site.