-
Notifications
You must be signed in to change notification settings - Fork 2
How to Contribute to EasyApp
Thank you for considering contributing to EasyApp! We welcome contributions from developers like you to make EasyApp even better.
You are an external contributor if you are not part of the EasyApp organization. If you plan to contribute code continue reading, otherwise you can jump to the issue section.
Before you can dive into contributing you must set up your environment. Follow these steps to do so.
-
Fork this repository. For more information see Fork a repo.
-
Clone the forked repository to your local machine:
git clone https://github.com/YOUR-USERNAME/EasyApp.git
-
Open the directory to ensure you followed the steps correctly. It should look like a 1-1 match with our repository.
-
You can now go to Building the extension.
You are an internal contributor if you are part of the EasyApp organization. Follow these steps to set up your
-
Clone this repository to your local machine:
git clone https://github.com/EasyApp-RPI/EasyApp.
-
You can now go to Building the extension
There are plenty of ways to contribute to EasyApp! Follow Building the Extension if you plan on contributing code. Make sure you have your dev environment set up. Otherwise checkout Issues for non code contributions.
-
Install Dependencies: Open the repository on your machine and install node packages with:
npm install
-
Build the Extension: Then build the chrome extension with:
npm run build
-
Load the Extension: Open Google Chrome and go to chrome://extensions/.
-
Enable Developer Mode: Toggle on "Developer mode" in the top right corner.
-
Load Unpacked: Click on "Load unpacked" and select the EasyApp/extension directory.
-
Rebuild: If you make changes to the React Chrome extension or autofill script. Make sure to rebuild the extension.
-
Permissions: If you modify extension permissions in the manifest, reload the extension.
-
Test and Enjoy: The EasyApp extension icon should now be in your Chrome toolbar. Click on it and enjoy!
If you plan to contribute code checkout the code contributions section.
Thank you for considering contributing to our project! Issues are a valuable way to get involved. Please follow these guidelines when creating issues:
If you encounter a bug, report it! Help us identify and resolve issues by providing the following:
- A clear and concise title summarizing the problem.
- Detailed steps to reproduce the bug.
- Screenshots or error logs, if applicable.
Have a great idea for a new feature? Share it with us by creating a feature request issue:
- Describe the desired functionality in detail.
- Explain why this feature would be valuable to the project.
If you want to suggest improvements to existing features, enhancement requests are the way to go:
- Clearly describe the enhancement or optimization you have in mind.
- Explain how it would benefit the project or user experience.
Don't hesitate to ask questions if you're unsure about something. We're here to help!
- Use a descriptive title for your question.
- Provide context and details to help others understand your query.
Feel free to explore existing issues to get a sense of how they're structured. Your contributions and engagement are greatly appreciated!
Here is an exhaustive list of ways you can contribute code to the project!
-
Fixing Bugs: Identify and fix existing bugs in the codebase. Provide clear explanations of the issue and the solution in your pull request.
-
Adding Features: Propose and implement new features that enhance EasyApp's functionality. Clearly outline the feature's purpose and benefits.
-
Optimizing Performance: Optimize the codebase for better performance. This can include improving algorithms, reducing resource usage, or enhancing user experience.
-
Refactoring: Contribute by refactoring code to make it more maintainable, readable, and adhering to best practices.
-
UI/UX Improvements: Enhance the user interface and user experience by improving design, layout, and usability.
-
Adding Documentation: Improve code documentation by adding comments, explanations, and guides for developers who work on the project in the future.
-
Writing Tests: Contribute by writing test cases to ensure the stability and reliability of EasyApp's codebase.
-
Accessibility Enhancements: Make the extension more accessible to a wider audience by ensuring it complies with accessibility standards.
-
Security Enhancements: Identify and fix potential security vulnerabilities in the code to ensure user data and privacy are protected.
Side Note: We try to keep our codebase as clean as possible so if you do end up committing any code make sure to write comments about its functionality. We also use prettier to format our code so before committing anything make sure to run the npm script that will format everything for you.
npm run formatWhen you're finished with the changes, create a pull request, also known as a PR.
- Fill out 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.
- We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can make any other changes in your clone, then commit them to the branch.
- As you update your PR and apply changes, mark each conversation as resolved.
- If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.
If you're new to Chrome extensions, here are some helpful resources:
If you're new to Typescript, here are some helpful resources:
We appreciate your contributions to EasyApp!
This project is licensed under the MIT License. See the LICENSE file for details.
A Rensselaer Center for Open Source project.