OpSo is a Flutter app that provides comprehensive information about various open-source programs, including Google Summer of Code, Summer of Bitcoin, Linux Foundation, and more. It allows users to explore different open-source opportunities, learn about their eligibility criteria, and access important resources.
This project is licensed under the MIT License.
Thank you for considering contributing to OpSo! We welcome contributions from the community to help improve the app and add new features. Below are some guidelines for contributing:
If you encounter any bugs or have ideas for new features, please open an issue on GitHub. Make sure to provide detailed information about the issue or feature request, including steps to reproduce the bug if applicable.
We appreciate any code contributions that enhance the functionality or improve the user experience of OpSo. To contribute code, follow these steps:
- Fork the repository to your GitHub account.
- Clone your forked repository to your local machine.
- Create a new branch for your feature or bug fix:
git checkout -b feature-name. - Make your changes and ensure that the code follows the Flutter style guide.
- Test your changes locally to ensure they work as expected.
- Commit your changes with descriptive commit messages:
git commit -m "Add feature XYZ". - Push your changes to your forked repository:
git push origin feature-name. - Create a pull request against the
mainbranch of the original repository.
To run the OpSo app locally, you need to have Flutter and Dart installed on your machine. Follow these steps:
- Clone this repository:
git clone https://github.com/andoriyaprashant/OpSo.git- Navigate to the project's root directory:
cd OpSo- Install dependencies:
flutter pub get- Check for Flutter setup and connected devices:
flutter doctor- Run the app:
flutter run## Troubleshooting
This section addresses common issues users may encounter while using the OpSo app, along with their solutions. If you experience any problems, refer to the list below:
Problem: Users may find that the search function does not return any results.
Solution:
- Ensure that you are entering the correct keywords related to the open-source programs.
- Try clearing the app cache and restarting the app.
- Check your internet connection as the search functionality relies on online resources.
Problem: The filter options do not seem to apply as expected.
Solution:
- Make sure you have selected at least one filter option before clicking apply.
- If the app crashes or behaves unexpectedly, try reinstalling the app.
- Confirm that you have the latest version of the app installed.
- An "all filters" option should be included to easily reset filters.
- Limited Program Listings: The app currently does not cover all available open-source programs. If you are looking for a specific program, check the official websites.
- Network Dependency: The app relies on a stable internet connection for fetching program details and updates. Offline functionality is limited.
If you encounter any issues not listed above, please open an issue on GitHub for further assistance.
If you would like to add information about a new open-source program to OpSo, you can contribute by:
- Gathering comprehensive information about the program, including its objectives, eligibility criteria, application process, and important dates.
- Creating a new screen in the app to display information about the program.
- Adding the program to the list of options in the home screen with relevant details.
- Testing the new feature to ensure it works correctly.
Good documentation is essential for the success of any open-source project. If you notice any areas where the documentation can be improved, feel free to make updates or additions.
|
GSSOC 2024 |
| This project is part of GirlScript Summer of Code. We enthusiastically welcome community contributions to enhance OpSo. |
Please note that by contributing to OpSo, you agree to abide by the code of conduct. We expect all contributors to uphold the principles of respect, inclusivity, and collaboration.