GUIDELINES FOR SWOC S4 2024 CONTRIBUTORS

[Mayuresh-22]

Myself Mayuresh Choudhary, Project Admin of Minglr - Social Networking Website.

Congratulations on making it this far in SWOC! 🎉

How to start with contributions in Minglr?

Thank you for choosing to contribute to the Minglr project in your open-source journey.

To start with I'll explain a step-by-step process to contribute to Minglr. I'll try to keep it as easy as possible.

1. I have/will create several GitHub issues with "SWOC S4" label, these issues will be categorized based on their difficulty level i.e. Beginner, Easy, Medium, Hard. Issues are problems in a project that need to be addressed.

   1. If you'd like, you can create your own issue and I'll assign it to you.

2. Select the issue that best suits you and comment on it saying "I want to work on this issue", wait for me to assign it to you.

3. Once I've assigned an issue, you can start working on it by following these sub-steps:

   1. Fork the repository. Forking is making a copy of my repository into your account. (You can fork the repository by clicking on the fork option in the top right corner)
   2. Create a new branch with a name that explains your changes, for example, if you are working on an issue that says fix the CSS then you can select the name new branch as fixing-CSS-issue-id (issue id is the unique no. of the issue)
   3. Clone the forked repository onto your local machine. I'll be creating a step-by-step video tutorial on how to set up the Minglr project on your local machine.
   4. Make appropriate changes and create a Pull Request, popularly known as PR (so don't get confused). PR is the process of submitting your proposed changes so that I can review them and merge them into the original Minglr repository. Isn't it COOLLLL
   5. If everything is good I'll merge your PR into Minglr and Congratulationsssss 🤩🎉 you've made your first successful contribution to Minglrrrr.

FAQ - Frequently Asked Question

I've tried to cover all the common questions.

1. What if multiple contributors comment on the same issue?
   I'll assign the issue based on the FCFS (First Come First Serve) manner. If you create an issue, it will be assigned only to you.

2. How long one can work on an issue?
   To ensure fairness for everyone, once an issue is assigned to you, you will have a maximum of two days to solve it and create a pull request. If you fail to create a pull request within this timeframe, the issue will be assigned to the next person who commented on the issue to work on.

3. Can you please clarify how the PRs (pull requests) will be documented and tracked?
   Once your PR is merged it will be considered as one contribution and I'll record it at my end. All the necessary details will be recorded. Just keep on contributing and I'll take care of keeping track of your successful contributions.

4. How many Max issues can I work on?
   There is no limit on the number of issues you can work on, but I suggest working on one issue at a time.

5. How can I start with SWOC?
   This is one of the most frequently asked questions, Assuming you have registered for SWOC and have completed all the prerequisites like joining the Quine platform, SOWC discord server etc. Please wait until the 1st of JAN 2024 as the event will start on that day. Till then you can select the project in which you want to contribute and that best suits you.
   To participate in the event, please familiarize yourself with the project codebase. Advanced users can try setting up the project on their local machine. The official start date for the event is on the 1st of JAN 2024. At this point, you can begin addressing the issues listed in your selected projects. Keep in mind that the process for contributing to a project may vary depending on the project and its admin. I have outlined a step-by-step process for contributing to the Minglr Project. Therefore you can connect with the project admin to learn more about the project.

6. Can I contribute in more than one project?
   Yes, you can. But I'll suggest you focus on one project at a time.

7. Where will I find all the projects of SWOC S4 ?
   Visit https://www.socialwinterofcode.com/project