From d6761236ce97e1a031be50a2dd4fc1bb2c524856 Mon Sep 17 00:00:00 2001 From: Manas Kenge <110519001+Manas-Kenge@users.noreply.github.com> Date: Tue, 17 Oct 2023 00:07:20 +0530 Subject: [PATCH 1/5] Added contribution guide --- CONTRIBUTING.md | 73 +++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 4 +++ 2 files changed, 77 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..512b547 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,73 @@ +# Welcome to Capture contributing guide + +Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on [Capture](https://github.com/khattakdev/capture) :sparkles: . + +In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR. + +## New contributor guide + +To get an overview of the project, read the [README](README.md). Here are some resources to help you get started with open source contributions: + +- [Finding ways to contribute to open source on GitHub](https://docs.github.com/en/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github) +- [Set up Git](https://docs.github.com/en/get-started/quickstart/set-up-git) +- [GitHub flow](https://docs.github.com/en/get-started/quickstart/github-flow) +- [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests) + + +## Getting started + +Before making code contributions, make sure to set up your development environment. Please follow the project's documentation for specific instructions. + + +### Issues + +#### Create a new issue + +If you spot a problem with the Capture, search if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue form. + +#### Solve an issue + +Scan through our [existing issues](https://github.com/khattakdev/capture/issues) to find one that interests you. You can narrow down the search using `labels` as filters. If you find an issue to work on, you are welcome to open a PR with a fix. + +### Make Changes + +#### Make changes in a codespace + +Make your code changes on this branch. Ensure your changes adhere to our coding guidelines. + +#### Make changes locally + +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 so that you can make your changes without affecting the original project until you're ready to merge them. + +2. Install or update to **Node.js**, at the version specified in `.node-version`. For more information, see the development guide. + +3. Create a working branch and start with your changes! + +### Commit your update + +Commit the changes once you are happy with them. Don't forget to self-review to speed up the review process:zap:. + +### Pull Request + +When you're finished with the changes, create a pull request, also known as a PR. +- Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request. +- Don't forget to link PR to issue if you are solving one. +- Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. +Once you submit your PR, a Capture 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 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. + +### Your PR is merged! + +Congratulations :tada::tada: The Capture team thanks you :sparkles:. + +Once your PR is merged, your contributions will be publicly visible on the Capture. + +Now that you are part of the Capture community, see how else you can contribute to the docs. + diff --git a/README.md b/README.md index 609a293..cebf3a0 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,10 @@ You can take the code snapshot in two steps: ## Contributing +See [the contributing guide](CONTRIBUTING.md) for detailed instructions on how to get started with our project. +We accept different types of contributions, including some that don't require you to write a single line of code. +If you're looking for a way to contribute, you can scan through our [existing issues](https://github.com/khattakdev/capture/issues) for something to work on. When ready, check out [Getting Started with Contributing](CONTRIBUTING.md) for detailed instructions. + ### Layout - `.vscode`: From c87fdadd6db3cde382c05e5b4191800c7649805d Mon Sep 17 00:00:00 2001 From: Manas Kenge <110519001+Manas-Kenge@users.noreply.github.com> Date: Tue, 17 Oct 2023 23:22:09 +0530 Subject: [PATCH 2/5] Added more info on codespaces --- CONTRIBUTING.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 512b547..29e7aae 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -33,7 +33,25 @@ Scan through our [existing issues](https://github.com/khattakdev/capture/issues) #### Make changes in a codespace -Make your code changes on this branch. Ensure your changes adhere to our coding guidelines. +To access GitHub Codespaces for the repository, follow these steps: + +1. Navigate to your repository on GitHub. + +2. Click on the "Code" button located at the top right of the repository page. + +3. Select "Open with Codespaces" from the dropdown menu. + +4. If you're using Codespaces for the first time, you might need to set up your Codespaces environment. Follow the on-screen instructions to configure your environment. + +Once you have configured your environment, you can start making changes to your GitHub repository using Codespaces. Here's what you can do: + +1. Edit Files: Open and edit files in the web-based Codespaces environment. You can use a built-in code editor (VS Code) or other tools. + +2. Run Commands: Execute commands in the integrated terminal to build, test, or run your project. + +3. Version Control: Use Git commands to manage your changes. You can commit, create branches, and push your commits directly to your GitHub repository. Codespaces also integrates with GitHub Pull Requests, allowing you to create and review pull requests from within the environment. + +4. Real-Time Collaboration: If you're working on a collaborative project, multiple users can access and work on the same Codespaces environment simultaneously, making real-time collaboration easy. #### Make changes locally From 1b1250ab8aeaf0cf7e1e295bab37f58406d311e7 Mon Sep 17 00:00:00 2001 From: Manas Kenge <110519001+Manas-Kenge@users.noreply.github.com> Date: Wed, 18 Oct 2023 13:18:30 +0530 Subject: [PATCH 3/5] Made suggested changes --- CONTRIBUTING.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 29e7aae..6a3a961 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -55,17 +55,16 @@ Once you have configured your environment, you can start making changes to your #### Make changes locally -1. Fork the repository. -- Using GitHub Desktop: +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 so that you can make your changes without affecting the original project until you're ready to merge them. - -2. Install or update to **Node.js**, at the version specified in `.node-version`. For more information, see the development guide. - -3. Create a working branch and start with your changes! +- **Using the command line**: + - To set up a working development environment, just fork the project git repository. + - Open your terminal and navigate to the directory where you want to store the project. Then, run the following command to clone the repository: git clone https://github.com/yourusername/capture.git + - Navigate into the project directory: `cd capture` + - Use npm to install the project's dependencies: `npm install` ### Commit your update From 442e7d46d3efb4ee908ad14eea1bdd809d8b77b6 Mon Sep 17 00:00:00 2001 From: Manas Kenge <110519001+Manas-Kenge@users.noreply.github.com> Date: Wed, 18 Oct 2023 13:33:17 +0530 Subject: [PATCH 4/5] Added Prettier configuration --- .prettierrc | 6 ++++++ package.json | 3 ++- 2 files changed, 8 insertions(+), 1 deletion(-) create mode 100644 .prettierrc diff --git a/.prettierrc b/.prettierrc new file mode 100644 index 0000000..8fccd8c --- /dev/null +++ b/.prettierrc @@ -0,0 +1,6 @@ +{ + "singleQuote": true, + "bracketSpacing": true, + "tabWidth": 4, + "printWidth": 120 + } \ No newline at end of file diff --git a/package.json b/package.json index feb0459..0ddca67 100644 --- a/package.json +++ b/package.json @@ -31,7 +31,8 @@ "watch": "tsc -watch -p ./", "pretest": "npm run compile && npm run lint", "lint": "eslint src --ext ts", - "test": "node ./out/test/runTest.js" + "test": "node ./out/test/runTest.js", + "format": "npx prettier --write ." }, "devDependencies": { "@types/mocha": "^10.0.2", From 2886f65815918eced65198600e02e2cf14d9b465 Mon Sep 17 00:00:00 2001 From: Manas Kenge <110519001+Manas-Kenge@users.noreply.github.com> Date: Thu, 19 Oct 2023 17:47:58 +0530 Subject: [PATCH 5/5] Removed unrequired files --- CONTRIBUTING.md | 90 ------------------------------------------------- README.md | 41 ---------------------- 2 files changed, 131 deletions(-) delete mode 100644 CONTRIBUTING.md delete mode 100644 README.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 6a3a961..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,90 +0,0 @@ -# Welcome to Capture contributing guide - -Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on [Capture](https://github.com/khattakdev/capture) :sparkles: . - -In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR. - -## New contributor guide - -To get an overview of the project, read the [README](README.md). Here are some resources to help you get started with open source contributions: - -- [Finding ways to contribute to open source on GitHub](https://docs.github.com/en/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github) -- [Set up Git](https://docs.github.com/en/get-started/quickstart/set-up-git) -- [GitHub flow](https://docs.github.com/en/get-started/quickstart/github-flow) -- [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests) - - -## Getting started - -Before making code contributions, make sure to set up your development environment. Please follow the project's documentation for specific instructions. - - -### Issues - -#### Create a new issue - -If you spot a problem with the Capture, search if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue form. - -#### Solve an issue - -Scan through our [existing issues](https://github.com/khattakdev/capture/issues) to find one that interests you. You can narrow down the search using `labels` as filters. If you find an issue to work on, you are welcome to open a PR with a fix. - -### Make Changes - -#### Make changes in a codespace - -To access GitHub Codespaces for the repository, follow these steps: - -1. Navigate to your repository on GitHub. - -2. Click on the "Code" button located at the top right of the repository page. - -3. Select "Open with Codespaces" from the dropdown menu. - -4. If you're using Codespaces for the first time, you might need to set up your Codespaces environment. Follow the on-screen instructions to configure your environment. - -Once you have configured your environment, you can start making changes to your GitHub repository using Codespaces. Here's what you can do: - -1. Edit Files: Open and edit files in the web-based Codespaces environment. You can use a built-in code editor (VS Code) or other tools. - -2. Run Commands: Execute commands in the integrated terminal to build, test, or run your project. - -3. Version Control: Use Git commands to manage your changes. You can commit, create branches, and push your commits directly to your GitHub repository. Codespaces also integrates with GitHub Pull Requests, allowing you to create and review pull requests from within the environment. - -4. Real-Time Collaboration: If you're working on a collaborative project, multiple users can access and work on the same Codespaces environment simultaneously, making real-time collaboration easy. - -#### Make changes locally - -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**: - - To set up a working development environment, just fork the project git repository. - - Open your terminal and navigate to the directory where you want to store the project. Then, run the following command to clone the repository: git clone https://github.com/yourusername/capture.git - - Navigate into the project directory: `cd capture` - - Use npm to install the project's dependencies: `npm install` - -### Commit your update - -Commit the changes once you are happy with them. Don't forget to self-review to speed up the review process:zap:. - -### Pull Request - -When you're finished with the changes, create a pull request, also known as a PR. -- Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request. -- Don't forget to link PR to issue if you are solving one. -- Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. -Once you submit your PR, a Capture 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 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. - -### Your PR is merged! - -Congratulations :tada::tada: The Capture team thanks you :sparkles:. - -Once your PR is merged, your contributions will be publicly visible on the Capture. - -Now that you are part of the Capture community, see how else you can contribute to the docs. - diff --git a/README.md b/README.md deleted file mode 100644 index cebf3a0..0000000 --- a/README.md +++ /dev/null @@ -1,41 +0,0 @@ -# Capture - -A VS Code plugin that generates a screenshot of the highlighted content. -![demo - how to capture](/assets/preview.gif) - -# Getting Started - -You can take the code snapshot in two steps: - -- Highlight the code -- Run the command `Capture: Take a snapshot` - -## Features - -- [x] Generate code snippets -- [x] Syntax highlighting -- [x] Adjustable image dimensions -- [ ] Customizable theme -- [ ] Customizable fonts - -## Contributing - -See [the contributing guide](CONTRIBUTING.md) for detailed instructions on how to get started with our project. -We accept different types of contributions, including some that don't require you to write a single line of code. -If you're looking for a way to contribute, you can scan through our [existing issues](https://github.com/khattakdev/capture/issues) for something to work on. When ready, check out [Getting Started with Contributing](CONTRIBUTING.md) for detailed instructions. - -### Layout - -- `.vscode`: - - - This directory contains configuration files for VS Code specific to your project. - - For example, it might include a launch.json file for debugging configurations. - -- `src`: - - - This directory contains the source files for your extension. - - Typically, this includes a extension.ts file, which is the main entry point for your extension. - -- `src/test`: - - This directory contains any tests for your extension. - - It usually includes a suite folder with extension test files.