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:
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:
- Open the Extension Management page by navigating to
chrome://extensions
. - Enable the "Developer mode" toggle.
- Click on the "Load unpacked" button and select the
dist
folder after runningnpm run build
in the cloned repository.
- Open the Extension Management page by navigating to
-
-
Make your desired changes to the codebase.
-
Test your changes by reloading the extension in your browser and verifying the functionality.
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.
To learn more about UniversalNotes and its development, you can visit the following resources:
- UniversalNotes Website - the official website of UniversalNotes.
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 [email protected] to disclose any security vulnerabilities
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!