From 235e2f5cb26779bcea9f9b4dee283c783817bde4 Mon Sep 17 00:00:00 2001 From: Karuna Tata Date: Tue, 27 May 2025 12:04:24 +0530 Subject: [PATCH 1/5] Create CONTRIBUTING.md --- CONTRIBUTING.md | 84 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 84 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..ea6f5123 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,84 @@ +# Welcome to DevRev developer docs's 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 + +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 + +- Descriptive +- Thoughtful +- Organized + +We recommend adding 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 it's exisiting 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 + +##### 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 for 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. + + + + + + + + + + + From 8bfe923ee942a9f126a6e28af1d650353323fda2 Mon Sep 17 00:00:00 2001 From: Karuna Tata Date: Wed, 28 May 2025 14:07:47 +0530 Subject: [PATCH 2/5] Update CONTRIBUTING.md Co-authored-by: Ben Colborn --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ea6f5123..91f6bbb8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# Welcome to DevRev developer docs's contributing guide! +# 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)🤖_ From e4f340ec9efcc09e127ec10aa759477c4fd79739 Mon Sep 17 00:00:00 2001 From: Karuna Tata Date: Wed, 28 May 2025 14:08:04 +0530 Subject: [PATCH 3/5] Update CONTRIBUTING.md Co-authored-by: Ben Colborn --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 91f6bbb8..e04f5e8f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -63,7 +63,7 @@ Once your changes are ready, don't forget to self-review your code to double che 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 for additional information. +- 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. From 56eced4e41d02c5928006aa7e84794724f0c036e Mon Sep 17 00:00:00 2001 From: Karuna Tata Date: Wed, 28 May 2025 14:08:14 +0530 Subject: [PATCH 4/5] Update CONTRIBUTING.md Co-authored-by: Ben Colborn --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e04f5e8f..052cc553 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,7 +16,7 @@ We recommend adding as many relevant links, minimal reproductions of the issue, ### Solve an issue -If you're interested in solving an issue in our repository, start by scanning through it's exisiting 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. +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 From dc55d4568489108a98c7dfda53ac24c5514d9842 Mon Sep 17 00:00:00 2001 From: Karuna Tata Date: Wed, 28 May 2025 14:08:24 +0530 Subject: [PATCH 5/5] Update CONTRIBUTING.md Co-authored-by: Ben Colborn --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 052cc553..6e52f1fc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,7 +12,7 @@ If you spot a problem within a repository, [search if an issue already exists](h - Thoughtful - Organized -We recommend adding as many relevant links, minimal reproductions of the issue, and other materials that will help our team solve the issue fast. +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