Skip to content

Commit

Permalink
docs: update dev instructions for chrome
Browse files Browse the repository at this point in the history
  • Loading branch information
rootCircle committed Dec 8, 2024
1 parent e576be4 commit 9f6adbe
Show file tree
Hide file tree
Showing 2 changed files with 58 additions and 63 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@ The Web Extension simplifies the process of filling Google forms by automating r

For detailed installation instructions, please refer to the [INSTALL.md](docs/INSTALL.md) file.

For development setup, see instructions in [CONTRIBUTING.md](./docs/CONTRIBUTING.md#development) file.

## Usage

Once the extension is installed, you can start using it immediately. Simply click on the extension icon in your browser toolbar to access its features. For usage instructions and additional details, please refer to the [documentation](docs).
Expand Down
119 changes: 56 additions & 63 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,69 @@ Thank you for considering contributing to docFiller! We welcome contributions fr

## Table of Contents

1. [Code of Conduct](#code-of-conduct)
2. [How Can I Contribute?](#how-can-i-contribute)
1. [Development Setup](#development)
2. [Code of Conduct](#code-of-conduct)
3. [How Can I Contribute?](#how-can-i-contribute)
- [Reporting Bugs](#reporting-bugs)
- [Suggesting Enhancements](#suggesting-enhancements)
- [Code Contributions](#code-contributions)
3. [Getting Started](#getting-started)
4. [Getting Started](#getting-started)
- [Setting Up the Development Environment](#setting-up-the-development-environment)
- [Forking the Repository](#forking-the-repository)
- [Creating a Branch](#creating-a-branch)
- [Making Changes](#making-changes)
4. [Submitting a Pull Request](#submitting-a-pull-request)
5. [Code Review](#code-review)
6. [License](#license)
5. [Submitting a Pull Request](#submitting-a-pull-request)
6. [Code Review](#code-review)
7. [License](#license)

## Development

If you're planning to contribute to the development of this web extension, here are some guidelines:

- Use `bun` instead of `npm`, `pnpm` or `yarn` while installing the packages, the project default package manager. You can install bun from [official website](https://bun.sh/).

- To get started, follow these steps:

1. Clone the repository:

```bash
git clone https://github.com/rootCircle/docFiller.git # Replace rootCircle with your username if you have forked the repo
```

2. Install the required dependencies:

```bash
bun i
```

3. Test the extension:

- Firefox

```bash
bun run dev:firefox
```

This will open a new Firefox window with the extension loaded.

- Chromium

```bash
bun run dev:chromium
```

4. **Make your changes**: Make the changes you want in your local copy of the repository.

5. **Test your changes**: Ensure that your changes work as expected. Test thoroughly before proceeding. Run lint checks before proceeding.

```bash
bun run lint
bun run format
```

To fix a set of lint issues simply run `bun run lint:fix`.

6. **Submit a Pull Request**: Once you've made your changes and tested them, submit a pull request (PR) to the original repository. Make sure to explain the changes you've made in the PR description.

## Code of Conduct

Expand Down Expand Up @@ -134,63 +184,6 @@ git push origin feature/your-feature-name

Then, open a Pull Request (PR) on the main repository. Be sure to provide a clear title and description of your changes.

## Development

If you're planning to contribute to the development of this web extension, here are some guidelines:

- Use `bun` instead of `npm`, `pnpm` or `yarn` while installing the packages, the project default package manager. You can install bun from [official website](https://bun.sh/).

- To get started, follow these steps:

1. Clone the repository:

```bash
git clone https://github.com/your-username/docFiller.git
```

2. Install the required dependencies:

```bash
bun i
```

3. Test the extension:

- Firefox

```bash
bun run dev:firefox
```

This will open a new Firefox window with the extension loaded.

- Chrome

- For Chrome, use the following command to watch for changes and load the extension:

```bash
bun run watch
```

- Open `chrome://extensions/` in Chrome.
- Enable **Developer mode**.
- Click **Load unpacked** and select the `build` directory.

Then, manually load the extension in Chrome.

4. **Make your changes**: Make the changes you want in your local copy of the repository.

5. **Test your changes**: Ensure that your changes work as expected. Test thoroughly before proceeding. Run lint checks before proceeding.

```bash
bun run lint
bun run format
```

To fix a set of lint issues simply run `bun run lint:fix`.

6. **Submit a Pull Request**: Once you've made your changes and tested them, submit a pull request (PR) to the original repository. Make sure to explain the changes you've made in the PR description.

## Code Review

Your PR will be reviewed by our maintainers, who may provide feedback or request further changes. Be responsive to their comments and update your branch as needed.
Expand Down

0 comments on commit 9f6adbe

Please sign in to comment.