Skip to content

Commit 2aab40e

Browse files
authored
Updated FAQs based on feedback (#40)
1 parent 2fa327e commit 2aab40e

File tree

4 files changed

+79
-21
lines changed

4 files changed

+79
-21
lines changed

docs/internships/gsoc/ideas.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: GSoC Ideas
44
sidebar_position: 2
55
---
66

7-
:::note
7+
:::note Change Policy
88

99
These ideas are subject to change at any time prior to us submitting our GSoC Organization application. Ideas may be added, removed or updated up to this time.
1010

@@ -16,6 +16,12 @@ These ideas are subject to change at any time prior to us submitting our GSoC Or
1616

1717
Welcome to our GSoC ideas page!
1818

19+
:::tip Tip
20+
21+
These are the minimum requirements. We encourage you to expand on them.
22+
23+
:::
24+
1925
### Repository Languages and Skills
2026

2127
Here is a list of basic skills that will be required for each repository.

docs/internships/gsoc/introduction.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,35 @@ Don't expect any feedback on the last week before the deadline, as this is when
6464
1. How to get familiar with the code base
6565
1. How to contact mentors
6666

67+
- **Q**: If I have a proposal idea, should I start proposing issues and begin work on it during the contribution period?
68+
- **A**: GSoC recommends that you don’t do this. Focus on fixing bugs or issues that may hold up your proposal if it is selected.
69+
70+
- **Q**: I’ve noticed most of Palisadoes’ intern alumni are university students. Do you have any additional eligibility criteria outside of the GSoC rules?
71+
- **A**: We only follow the GSoC rules.
72+
73+
- **Q**: Is it possible to get accepted for two different proposals/GSOC slots?
74+
- **A**: Please refer to the GSoC rules.
75+
76+
- **Q**: Can we submit multiple proposals to the Palisadoes Foundation?
77+
- **A**: Please refer to the GSoC rules.
78+
79+
- **Q**: I have an idea in mind, and would like to code a small demonstration, can I do that?
80+
- **A**: GSoC recommends that you don't start coding your projects beforehand. Focus on creating a clear proposal.
81+
82+
- **Q**: What do the “GSoC Priority” GitHub issue labels signify?
83+
- **A**: The “GSoC Priority” labels are not considered in the application process. They help us track the issues that need to be completed before the GSoC work period to maximize the success of our projects.
84+
85+
- **Q**: Can we create a completely original proposal that’s not in the Ideas List?
86+
- **A**: Yes. Our Hybrid ideas were created to encourage this.
87+
88+
:::info General Expectations
89+
90+
In the past we published the number of GSoC slots requested, slots received and the ranking of proposals. This created a lot of over-analysis and misunderstandings which was unhealthy. We now have a policy of not providing this information for any internship program.
91+
92+
Each year, we may approach unsuccessful candidates to become formal contributors to the Palisadoes Foundation's GitHub account. This small group will have a wide range of experiences and abilities. In many cases we will be taking a chance. We hope this will encourage you to remain active, improve, add features and be more prepared for your careers and subsequent internship programs either with us or other organizations. This is not a guarantee for selection in our future programs.
93+
94+
:::
95+
6796
## Thanks!
6897

6998
Thank you for considering The Palisadoes Foundation for your Google Summer of Code!

docs/internships/introduction/application-template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ The following must be in your deliverables:
6666

6767
### Project Details
6868

69-
1. Elaborate your project idea. Here is the place to add technical explanations, architecture diagrams or UI/UX mockups.
69+
1. Elaborate your project idea. Here is the place to add technical explanations. Consider the appropriate use of visual aids such as schematics, architecture diagrams or UI/UX mockups.
7070
1. Make sure that your vision is clear and avoid fuzzy promises that you aren't sure about.
7171
1. If you have doubts, research and ask for feedback and clarifications beforehand.
7272

docs/internships/introduction/faq.md

Lines changed: 42 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ Your application **must** follow our [application template](../introduction/appl
1414
:::
1515

1616
- **Q**: What will most help my odds of acceptance?
17-
1817
- **A**: There are a number of things you can do to help your odds
1918

2019
1. [A quality proposal](../introduction/application-template.md) - a well thought out proposal that shows you understand what you want to do and have reasonable expectations about what can be accomplished in the time you will have available.
@@ -23,10 +22,15 @@ Your application **must** follow our [application template](../introduction/appl
2322
1. Discuss your application with us and get some feedback. You can chat with us on slack and post a link to your proposal.
2423

2524
- **Q**: What acceptance criteria are used?
26-
2725
- **A**: These are the most important considerations
2826
1. Contributors must abide by our code of conduct guidelines at all times. This can be found in the [CODE_OF_CONDUCT.md](https://github.com/PalisadoesFoundation/developer-docs/blob/main/CODE_OF_CONDUCT.md) file in each repository.
29-
1. We want you to be successful in creating transformative projects. Your pull requests must be able to prove your abilities to do so. We **do not count** the number of pull requests in our evaluations. Excessive numbers of commits, abandoned and prematurely closed pull requests indicate struggles in mastering the code base.
27+
1. We want you to be successful in creating transformative projects. Your pull requests must be able to prove your abilities to do so.
28+
- We **do not count** the number of pull requests in our evaluations, only the quality.
29+
- Pull requests with these characteristics indicate struggles in mastering the code base:
30+
- excessive numbers of commits;
31+
- ignoring reviewer guidance;
32+
- abandonment; and
33+
- premature closures.
3034
1. Think of all the stakeholders. End users, administrators, and the DevOps teams that will use the application. If any of these groups don’t find it useful and usable, then it won’t be installed, evaluated and implemented. Many technically excellent proposals have been surpassed by ones that consider making all the stakeholders happy. We highly value proposals that consider:
3135
- Practicability,
3236
- Performance,
@@ -36,24 +40,32 @@ Your application **must** follow our [application template](../introduction/appl
3640
- Intuitive UI/UX. (This is often underappreciated)
3741

3842
Our ideas list gives an outline of what we'd like to see implemented, but do not limit your proposal to this bare minimum. Copying feature functionality from other sources without improving upon them is insufficient, our code must always be better. Expand on the possibilities to meet our innovation requirements. We greatly value innovative features and approaches.
43+
44+
If one of the stakeholders is a non-profit organization such as your local temple, mosque, church, community center, or sports club remember that they often don’t have staff comfortable with IT, and frequently don’t have ample reliable financial resources. In these cases, make your solutions intuitive, simple and cost effective.
45+
3946
1. Positive mentor interactions.
4047

4148
- **Q**: How do you maintain evaluation impartiality?
42-
4349
- **A**: We review proposals using our [Conflict of Interest](../introduction/conflicts-of-interest) policy.
4450

45-
:::info GSoC
51+
- **Q**: Will contributions in repositories external to my proposal be considered?
52+
- **A**: Yes, if they demonstrate your ability to be successful on the project. We prioritize prior work related to your proposal and its code stack.
4653

47-
In the past we published the number of GSoC slots requested, slots received and the ranking of proposals. This created a lot of over-analysis and misunderstandings which was unhealthy. We now have a policy of not providing this information for any internship program.
54+
- **Q**: How should I approach writing a draft proposal?
55+
- **A**: Get a mentor’s input at the early outline stage.
4856

49-
Each year, we may approach unsuccessful candidates to become formal contributors to the Palisadoes Foundation's GitHub account. This small group will have a wide range of experiences and abilities. In many cases we will be taking a chance. We hope this will encourage you to remain active, improve, add features and be more prepared for your careers and subsequent internship programs either with us or other organizations. This is not a guarantee for selection in our future programs.
57+
- **Q**: Do you provide sample proposals?
58+
- **A**: No.
5059

51-
:::
60+
- **Q**: Do you accept proposals that create breaking changes to the code base?
61+
- **A**: No.
5262

53-
## Contributions
63+
- **Q**: Can we introduce third party solutions with project ideas?
64+
- **A**: Yes, but only if the cost is borne 100% by the end user or end user organization. Our organization cannot be expected to cover the cost of all potential users around the globe. The setup and configuration must always be simple and intuitive.
5465

55-
- **Q**: I want to get involved before submitting my application. Can you guide me?
66+
## Contributing
5667

68+
- **Q**: I want to get involved before submitting my application. Can you guide me?
5769
- **A**: Getting involved early and showing presence is a good idea and increases your chances for acceptance.
5870
1. On the other hand, contributors have to show that they can take steps by themselves, without much "handholding".
5971
Mentors will try to help contributors make it successfully through the project; their job is not to give guidance on every step of the way. Of course, the usual communication channels are available to contributors for when they need help on specific topics. Together with our developer introduction guides, contributors should be able to get started.
@@ -65,9 +77,15 @@ Your application **must** follow our [application template](../introduction/appl
6577
3. You can subscribe to our [mailing list](https://www.freelists.org/list/palisadoes).
6678

6779
- **Q**: What tutorials can I use to prepare for my first contributions?
68-
6980
- **A**: We have a lot of videos on our YouTube channel. Our "[Getting Started - Developers](https://www.youtube.com/watch?v=YpBUoHxEeyg&list=PLv50qHwThlJUIzscg9a80a9-HmAlmUdCF)" playlist will help you understand our processes better.
7081

82+
- **Q**: Sometimes work in one repository requires changes in another. What should I do?
83+
- **A**: Create corresponding issues in the other repository for you or another contributor to address. Ask to be assigned if required. Familiarity with related repositories could be useful if you are selected.
84+
85+
- **Q**: Is there a deadline for submitting PRs during the application period?
86+
- **A**: No.
87+
88+
7189
:::info
7290

7391
It's very important that you watch all the short videos in our "[Getting Started - Developers](https://www.youtube.com/watch?v=YpBUoHxEeyg&list=PLv50qHwThlJUIzscg9a80a9-HmAlmUdCF)" playlist. They explain our community values, coding principles and ways to avoid the most common mistakes.
@@ -77,43 +95,48 @@ It's very important that you watch all the short videos in our "[Getting Started
7795
## Our Code Base
7896

7997
- **Q**: Is there some place that tells me the process of using the project's code?
80-
8198
- **A**: Visit our [project pages](../../introduction/projects.md) for complete documentation.
8299

83100
- **Q**: Where can I learn more about a project's code base?
84-
85101
- **A**: There is quite a bit of good documentation [here](../../introduction/projects.md).
86102

87103
- **Q**: The code base is huge! Where do I start?
88-
89104
- **A**: Have a look at the directory structure. Each code file documents its purpose each class, function and method is similarly documented.
90105

91106
- **Q**: I want to get involved before submitting my application. Can you guide me?
92-
93107
- **A**: Getting involved early and showing presence is a good idea and increases your chances for acceptance. On the other hand, contributors have to show that they can take steps by themselves, without much "handholding". Mentors will try to help contributors make it successfully through the project; their job is not to give guidance on every step of the way. Of course, the usual communication channels are available to contributors for when they need help on specific topics. Together with the developer introduction guides, contributors should be able to get started.
94108

95109
So take some initiative yourself. Show that you are capable of working on your own (to a good degree), that you can figure simple things out yourself and that you know when and where to ask questions.
96110

97111
## Mentor Contact
98112

99-
- **Q**: How can I contact internship mentors?
100-
113+
- **Q**: What is the best way to contact internship mentors?
101114
- **A**: There are many options:
102115

103-
1. Get in contact with them via our slack channel.
116+
1. Get in contact with them via our slack channel or GitHub
104117
1. Send an email to:
105118

106119
![img](/img/markdown/internships/mentors.png)
107120

108-
- **Q**: How can I feedback on my internship proposal?
121+
Please be patient, and **do not spam** their social media accounts or other avenues.
122+
123+
- **Q**: Should I call the mentors and organizers by “Sir” or “Ma’am”?
124+
- **A**: No, our first names are fine. We don’t mind, but don’t expect it.
109125

126+
- **Q**: How can I feedback on my internship proposal?
110127
- **A**: Send an email to this address with a link to your proposal in Google Docs:
111128

112129
![img](/img/markdown/internships/draft-submissions.png)
113130

131+
- **Q**: How should I interact with mentors about my proposal idea?
132+
- **A**: Do thorough research and contact the assigned mentors for guidance on its suitability. Mentors do not need constant updates, it’s best to arrange scheduled updates or meetings. Ask the mentor for the best approach.
114133

115134
:::danger Submit early if you want feedback
116135

117136
Don't expect any feedback on the last week before the deadline, as this is when most applications come in.
118137
:::
119138

139+
## Other
140+
141+
- **Q**: Are there any common mistakes that we should as applicants avoid?
142+
- **A**: Submit your application on time. Get early mentor feedback on your proposal. When you are stuck, ask our community for assistance after attempting a solution.

0 commit comments

Comments
 (0)