diff --git a/README.md b/README.md index 891f7220..5ba8ecb9 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,9 @@ # UT Registration Plus +![Chrome Web Store](https://img.shields.io/chrome-web-store/v/hboadpjkoaieogjimneceaahlppnipaa) +![Downloads](https://img.shields.io/chrome-web-store/d/hboadpjkoaieogjimneceaahlppnipaa) +![License](https://img.shields.io/github/license/Longhorn-Developers/UT-Registration-Plus) + We've all been there. 20 tabs of Rate My Professor, Google Spreadsheet, and the UT Course Schedule open and you still don't know what classes to take. This extension, UT Registration Plus (UTRP), tries to streamline most of the unnecessary steps and headaches of registering for classes at UT Austin. @@ -30,6 +34,19 @@ This extension, UT Registration Plus (UTRP), tries to streamline most of the unn - Semantic-Release - Custom Messaging & Storage Wrappers +## Contributing + +Contributions are welcome and encouraged! To contribute, please follow these steps: + +1. Fork the repository +2. Create a new branch (`git checkout -b feature/your-feature`) +3. Make your changes and ensure the code follows the linting and formatting rules (`pnpm run lint` and `pnpm run prettier`) +4. Commit your changes following the **Conventional Commits** specification +5. Push to the branch (`git push origin feature/your-feature`) +6. Open a Pull Request + +For large changes, it's recommended to open an issue first to discuss your proposed changes. + ## Development: Getting Started 1. Clone this repo @@ -57,3 +74,81 @@ Use `BETA=true pnpm build` to build a beta build. Open [chrome://extensions](chrome://extensions), ensure you have 'Developer Mode' enabled, and click 'Load unpacked'. Navigate to the `dist/` folder, and click 'select' to import the extension. + +## Bug Reporting + +If you encounter any bugs or issues, please submit a detailed report in the [Issues](https://github.com/Longhorn-Developers/UT-Registration-Plus/issues) section. Be sure to include: + +- A descriptive title +- Steps to reproduce the issue +- Expected behavior +- Screenshots or logs (if applicable) + +We will address issues as promptly as possible. + +## Conventional Commits & Branch Naming Convention + +We follow the **Conventional Commits** specification for commit messages. This helps us maintain a consistent history, enabling automated versioning and changelog generation. + +### Commit Messages + +Please format your commit messages as follows: + +``` +(): +``` + +Where: + +- **type**: One of the following: + - `feat`: A new feature + - `fix`: A bug fix + - `docs`: Documentation changes + - `style`: Code formatting (white-space, formatting, missing semi-colons, etc.) + - `refactor`: Code restructuring (neither fixes a bug nor adds a feature) + - `test`: Adding or modifying tests + - `chore`: Changes to the build process or auxiliary tools + +Example: + +``` +feat(auth): add login functionality +fix(ui): correct button alignment +``` + +### Branch Naming + +Branch names should follow the format: + +``` +/ +``` + +Examples: + +- `feat/user-login` +- `fix/navbar-layout` +- `docs/update-readme` + +## License + +This project is licensed under the MIT License. See the [LICENSE](./LICENSE.md) file for more details. + +## Code of Conduct [TODO] + +We adhere to a strict code of conduct. By participating, you are expected to uphold this code. Please read [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md) for details. + +## Acknowledgements + +This project leverages several powerful open-source tools and libraries. Special thanks to the developers behind: +- React 18 +- TypeScript +- Vite 5 +- ESLint +- Prettier +- Storybook +- Semantic-Release +- UT Registration Plus v1 with @sghsri as the original author for creating the foundation of UTRP and impacting thousands of UT students positively via his Chrome Extension +- [UT Registration Planner](https://github.com/doprz/UT-Registration-Planner) was archived and it's developer @doprz joined UT Registration Plus in 2023 +- [Longhorn Developers](https://github.com/Longhorn-Developers) organization was created in 2024 for further development of UTRP and other student-led projects. +- All UTRP devs, beta testers, and anyone who helped support this project