Skip to main content

​
Contributing to Page Assist

Thank you for your interest in contributing to Page Assist! We welcome contributions from anyone, whether it’s reporting bugs, suggesting improvements, or submitting code changes.

​
Getting Started

​
1. Fork the Repository

To start contributing, you’ll need to fork the Page Assist repository by clicking the “Fork” button at the top right of the page.

​
2. Clone Your Fork

Once you have your own fork, clone it to your local machine: 
git clone https://github.com/YOUR-USERNAME/page-assist.git
cd page-assist

​
3. Install Dependencies

Page Assist uses Bun for dependency management. Install the required dependencies by running the following command in the project root directory: 
bun install
If you face any issues with Bun, you can use npm instead.

​
4. Start the Development Server

To run the extension in development mode, use the following command: 
bun dev
This will open a Chrome browser window with the extension loaded. For Firefox: 
bun dev:firefox

​
5. Install Ollama Locally

Page Assist requires Ollama to be installed locally for testing. Follow the installation instructions provided in the Ollama documentation.

​
Making Changes

Once you have the project set up locally, you can start making changes. We recommend creating a new branch for your changes: 
git checkout -b my-feature-branch
Make your desired changes, and don’t forget to add or update tests if necessary.

​
Submitting a Pull Request

​
1. Commit Your Changes

Once you’ve made your changes, commit them with a descriptive commit message: 
git commit -m "Add a brief description of your changes"

​
2. Push Your Changes

Push your changes to your forked repository: 
git push origin my-feature-branch

​
3. Open a Pull Request

Go to the original repository on GitHub and click the “New Pull Request” button. Select your forked repository and the branch you just pushed as the source, and the main repository’s main branch as the destination.

​
4. Describe Your Changes

Provide a clear and concise description of the changes you’ve made, including any relevant issue numbers or other context.

​
5. Review and Merge

The maintainers of the project will review your pull request and provide feedback or merge it if everything looks good.

​
Code Style and Guidelines

To ensure consistency and maintainability, we follow certain code style guidelines. Please ensure your code adheres to these guidelines before submitting a pull request:
  • Use proper indentation and code formatting
  • Write clear and concise comments when necessary
  • Follow best practices for TypeScript and React development
  • Test your changes thoroughly before submitting

​
Ways to Contribute

There are many ways to contribute to Page Assist:
  • Report Bugs: Found a bug? Open an issue on GitHub with detailed reproduction steps
  • Suggest Features: Have an idea for a new feature? Create an issue and let us know
  • Improve Documentation: Help us make our documentation better
  • Fix Bugs: Check the issues page for bugs that need fixing
  • Add Features: Implement new features from our roadmap or your own ideas
  • Translate: Help translate Page Assist to other languages

​
Need Help?

If you have any questions or need further assistance:

​
Community

GitHub

View the source code and open issues

Discord

Join our community chat

Twitter

Follow us for updates

Documentation

Read the full documentation
Thank you for your contribution!

Build docs developers (and LLMs) love

Get started for freeTalk to us