UniversalNotes Developer Guide

UniversalNotes is an open-source browser extension that brings Community Notes from Twitter to every website. As a developer, you can contribute to the project. Here's how you can get started:

Getting Started

To get started with UniversalNotes development or to use the extension locally, follow these steps:

Fork the UniversalNotes repository on GitHub.
Clone the forked repository to your local machine.
Load the extension in your browser:
- For Chrome:
  1. Open the Extension Management page by navigating to chrome://extensions.
  2. Enable the "Developer mode" toggle.
  3. Click on the "Load unpacked" button and select the extension folder in the cloned repository.
Make your desired changes to the codebase.
Test your changes by reloading the extension in your browser and verifying the functionality.

Contributing

If you would like to contribute to UniversalNotes, please follow these guidelines:

Create a new branch for your changes:
```
git checkout -b feature/my-feature
```
Commit your changes with descriptive commit messages:
```
git commit -m "Add new feature"
```
Push your branch to your forked repository:
```
git push origin feature/my-feature
```
Open a pull request on the main UniversalNotes repository and provide a detailed description of your changes.

Resources

To learn more about UniversalNotes and its development, you can visit the following resources:

UniversalNotes Website - the official website of UniversalNotes.

Security

If you believe you have found a security vulnerability in UniversalNotes, we encourage you to responsibly disclose this and not open a public issue. We will investigate all legitimate reports. Email amal@teegle.app to disclose any security vulnerabilities

Support

If you need any support or have any questions, you can:

Join the UniversalNotes community on Discord.
Open an issue on the UniversalNotes GitHub repository.

Happy coding and contributing to UniversalNotes!

amalsony / universalnotes