Skip to content

Latest commit

 

History

History
151 lines (100 loc) · 6.48 KB

CONTRIBUTING.md

File metadata and controls

151 lines (100 loc) · 6.48 KB
Raw

Contributing Guidelines 📄

This documentation contains a set of guidelines to help you during the contribution process. We are happy to welcome all the contributions from anyone willing to improve/add new scripts to this project. Thank you for helping out and remember, no contribution is too small.
Please note we have a code of conduct please follow it in all your interactions with the project.


Need some help regarding the basics?🤔

You can refer to the following articles on basics of Git and Github and also contact the Project Mentors, in case you are stuck:


Alternatively contribute using GitHub Desktop

  1. Open GitHub Desktop: Launch GitHub Desktop and log in to your GitHub account if you haven't already.

  2. Clone the Repository:

    • If you haven't cloned the OpSo repository yet, you can do so by clicking on the "File" menu and selecting "Clone Repository."
    • Choose the OpSo repository from the list of repositories on GitHub and clone it to your local machine.

  3. Switch to the Correct Branch:

    • Ensure you are on the branch that you want to submit a pull request for.
    • If you need to switch branches, you can do so by clicking on the "Current Branch" dropdown menu and selecting the desired branch.

  4. Make Changes: Make your changes to the code or files in the repository using your preferred code editor.

  5. Commit Changes:

    • In GitHub Desktop, you'll see a list of the files you've changed. Check the box next to each file you want to include in the commit.
    • Enter a summary and description for your changes in the "Summary" and "Description" fields, respectively. Click the "Commit to " button to commit your changes to the local branch.

  6. Push Changes to GitHub: After committing your changes, click the "Push origin" button in the top right corner of GitHub Desktop to push your changes to your forked repository on GitHub.

  7. Create a Pull Request:

  • Go to the GitHub website and navigate to your fork of the OpSo repository.
  • You should see a button to "Compare & pull request" between your fork and the original repository. Click on it.

  1. Review and Submit:

    • On the pull request page, review your changes and add any additional information, such as a title and description, that you want to include with your pull request.
    • Once you're satisfied, click the "Create pull request" button to submit your pull request.

  2. Wait for Review: Your pull request will now be available for review by the project maintainers. They may provide feedback or ask for changes before merging your pull request into the main branch of the OpSo repository.

⭐️ Support the Project If you find this project helpful, please consider giving it a star on GitHub! Your support helps to grow the project and reach more contributors.

Issue Report Process 📌

  1. Go to the project's issues.
  2. Give proper description for the issues.
  3. Don't spam to get the assignment of the issue 😀.
  4. Wait for till someone is looking into it !.
  5. Start working on issue only after you got assigned that issue 🚀.

We welcome contributions from the community to help improve the app and add new features. Below are some guidelines for contributing:

Bug Reports and Feature Requests

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.

Code Contributions

We appreciate any code contributions that enhance the functionality or improve the user experience of OpSo. To contribute code, follow these steps:

  1. Fork the repository to your GitHub account.
  2. Clone your forked repository to your local machine.
  3. Create a new branch for your feature or bug fix: git checkout -b feature-name.
  4. Make your changes and ensure that the code follows the Flutter style guide.
  5. Test your changes locally to ensure they work as expected.
  6. Commit your changes with descriptive commit messages: git commit -m "Add feature XYZ".
  7. Push your changes to your forked repository: git push origin feature-name.
  8. Create a pull request against the main branch of the original repository.

Getting Started

To run the OpSo app locally, you need to have Flutter and Dart installed on your machine. Follow these steps:

  1. Clone this repository:
git clone https://github.com/andoriyaprashant/OpSo.git
  1. Navigate to the project's root directory:
cd OpSo
  1. Install dependencies:
flutter pub get
  1. Check for Flutter setup and connected devices:
flutter doctor
  1. Run the app:
flutter run

Adding New Open Source Programs

If you would like to add information about a new open-source program to OpSo, you can contribute by:

  1. Gathering comprehensive information about the program, including its objectives, eligibility criteria, application process, and important dates.
  2. Creating a new screen in the app to display information about the program.
  3. Adding the program to the list of options in the home screen with relevant details.
  4. Testing the new feature to ensure it works correctly.

Improving Documentation

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.

Pull Request Process 🚀

  1. Ensure that you have self reviewed your code 😀
  2. Make sure you have added the proper description for the functionality of the code
  3. I have commented my code, particularly in hard-to-understand areas.
  4. Add screenshot it help in review.
  5. Submit your PR by giving the necesarry information in PR template and hang tight we will review it really soon 🚀

Thank you for contributing💗