-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Description
Everyone, welcome to our GitHub repository! Thanks for showing interest in the Commons Android app.
I am posting this information as some of you have messaged me asking where to get started.
How do I get started?
- Look for "good-first-issues" and volunteer to pick one up. Also, some of the issues might have been assigned a long ago, so you can comment on the issue thread to check whether someone is actually working on it or not. It can be then reassigned.
- Apart from "good-first-issues", you can look for issues with labels "bug" or "tests" and take one up.
- Also, compile and run the app on your phone and I am sure you will find numerous minor issues. You can create a new issue on Github and then write that you volunteer to fix it.
- Moreover, if you don't find anything at all, then feel free to add unit test cases for any classes that are missing tests. :)
- Github is our primary tool for communication with volunteers. Feel free to create a new issue on GitHub if you get stuck with anything or if in doubt. One of our collaborators will check and reply on the issue in a few days. Use Github if:
- If you come across an undocumented bug and want to report/fix it
- If you have a new feature suggestion
- If you are having trouble setting up your local environment
- Anything else related to the codebase as long as it doesn't require personal attention
- Feel free to mail one of the collaborators/maintainers if there's something you want to discuss in private.
Are there any guidelines for volunteering for this project?
Check the volunteer guide and contributing guidelines for more details.
- https://github.com/commons-app/commons-app-documentation/blob/master/android/Contributing-Guidelines.md
- https://github.com/commons-app/commons-app-documentation/blob/master/android/Volunteers-welcome!.md
Important Note
-
The number of contributions you make will not be the primary criterion for choosing the intern. So please don't feel pressured to make the biggest number of contributions.
-
Please avoid creating a pull request for an issue until the issue has been assigned to you.
Communication
- Feel free to create Github issues whenever you get stuck with anything and are not sure how to proceed. Github is usually must faster and more convenient as our project has a lot of active collaborators who keep an eye on all the threads.
- Once the intern is selected, we will add them to Zulip. You don't need to be on Zulip right now.
Submitting a proposal
In the proposal, we want to see the timeline and understand how you have broken down the main task into small sub-tasks. Please make sure that you are able to clearly mention the sub tasks and provide a good estimate of the time you think it might take. Also, factor in time for documentation and unit test cases.
Things to note:
- provide a clear timeline
- Mention your unavailability or other prior commitments.
- Outreachy doesn't allow you to take up another part-time/internship whereas GSoC does not have any such restriction. So if you are planning to take part-time apart from this internship then please mention it clearly in the proposal.
You can find sample proposals here:
https://phabricator.wikimedia.org/project/board/3795/query/all/