Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
133 changes: 64 additions & 69 deletions docs/internships/introduction/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,77 +14,73 @@ Your application **must** follow our [application template](../introduction/appl
:::

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

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.
1. Show evidence of past experience or achievements related to the proposal.
1. Make a useful patch for the code base - this shows that you can successfully read, edit, and compile our code.
1. Discuss your application with us and get some feedback. You can chat via DM with us on our [Community Forums](https://community.talawa.io/) and post a link to your proposal.
- **A**: There are a number of things you can do to help your odds
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.
1. Show evidence of past experience or achievements related to the proposal.
1. Make a useful patch for the code base - this shows that you can successfully read, edit, and compile our code.
1. Discuss your application with us and get some feedback. You can chat via DM with us on our [Community Forums](https://community.talawa.io/) and post a link to your proposal.

- **Q**: What acceptance criteria are used?
- **A**: These are the most important considerations
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.
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, only the quality.
- Pull requests with these characteristics indicate struggles in mastering the code base:
- excessive numbers of commits;
- ignoring reviewer guidance;
- abandonment; and
- premature closures.
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:
- Practicability,
- Performance,
- Ease of long term support. (eg. Packages that are actively managed and backed by a corporation versus ones created by a single person; proven versus leading edge approaches.)
- Usability,
- Perceived stakeholder value,
- Intuitive UI/UX. (This is often underappreciated)
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.

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.

1. Positive mentor interactions.
- **A**: These are the most important considerations
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.
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, only the quality.
- Pull requests with these characteristics indicate struggles in mastering the code base:
- excessive numbers of commits;
- ignoring reviewer guidance;
- abandonment; and
- premature closures.
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:
- Practicability,
- Performance,
- Ease of long term support. (eg. Packages that are actively managed and backed by a corporation versus ones created by a single person; proven versus leading edge approaches.)
- Usability,
- Perceived stakeholder value,
- Intuitive UI/UX. (This is often underappreciated)

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.

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.

1. Positive mentor interactions.

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

- **Q**: Will contributions in repositories external to my proposal be considered?
- **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.
- **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.

- **Q**: How should I approach writing a draft proposal?
- **A**: Get a mentor’s input at the early outline stage.
- **Q**: How should I approach writing a draft proposal?
- **A**: Get a mentor’s input at the early outline stage.

- **Q**: Do you provide sample proposals?
- **A**: No.
- **Q**: Do you provide sample proposals?
- **A**: No.

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

- **Q**: Can we introduce third party solutions with project ideas?
- **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.
- **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.

## Contributing

- **Q**: I want to get involved before submitting my application. Can you guide me?
- **A**: Getting involved early and showing presence is a good idea and increases your chances for acceptance.
1. 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 our developer introduction guides, contributors should be able to get started.

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.

1. Research the [GitHub issue trackers for all the projects](../../introduction/projects)
2. Introduce yourself on our `#general` slack channel. You can join our Slack Channel using the link on the [Palisadoes Foundation GitHub Home Page](http://github.com/PalisadoesFoundation).
3. You can subscribe to our [mailing list](https://www.freelists.org/list/palisadoes).
- **A**: Getting involved early and showing presence is a good idea and increases your chances for acceptance.
1. On the other hand, contributors have to show that they can take steps by themselves, without much "handholding".
1. 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.
2. 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.
2. Research the [GitHub issue trackers for all the projects](../../introduction/projects)
3. Introduce yourself in our [Community Forum](https://community.talawa.io/)
4. You can subscribe to our [mailing list](https://www.freelists.org/list/palisadoes).

- **Q**: What tutorials can I use to prepare for my first contributions?
- **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.
- **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.

- **Q**: Sometimes work in one repository requires changes in another. What should I do?
- **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.

- **Q**: Is there a deadline for submitting PRs during the application period?
- **A**: No.
- **Q**: Sometimes work in one repository requires changes in another. What should I do?
- **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.

- **Q**: Is there a deadline for submitting PRs during the application period?
- **A**: No.

:::info

Expand All @@ -95,41 +91,40 @@ It's very important that you watch all the short videos in our "[Getting Started
## Our Code Base

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

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

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

- **Q**: I want to get involved before submitting my application. Can you guide me?
- **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.
- **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.

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.
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.

## Mentor Contact

- **Q**: What is the best way to contact internship mentors?
- **A**: There are many options:

1. Get in contact with them via our slack channel or GitHub
1. Send an email to:
- **Q**: What is the best way to contact internship mentors?
- **A**: There are many options:
1. Get in contact with them via our [Community Forum](https://community.talawa.io/) or GitHub
1. Send an email to:

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

Please be patient, and **do not spam** their social media accounts or other avenues.
Please be patient, and **do not spam** their social media accounts or other avenues.

- **Q**: Should I call the mentors and organizers by “Sir” or “Ma’am”?
- **A**: No, our first names are fine. We don’t mind, but don’t expect it.
- **Q**: Should I call the mentors and organizers by “Sir” or “Ma’am”?
- **A**: No, our first names are fine. We don’t mind, but don’t expect it.

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

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

- **Q**: How should I interact with mentors about my proposal idea?
- **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.
- **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.

:::danger Submit early if you want feedback

Expand All @@ -139,4 +134,4 @@ Don't expect any feedback on the last week before the deadline, as this is when
## Other

- **Q**: Are there any common mistakes that we should as applicants avoid?
- **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.
- **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.
2 changes: 1 addition & 1 deletion docs/introduction/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Here is a quick guide on getting started with our projects.
2. Get familiar with the [important files in each repository](#important-files). They cover details that are excluded in our summary YouTube videos.
3. If you are new to GitHub and collaborative coding then [read our GitHub Quick-Start Guide](../git-guide/introduction/quickstart.md).
4. Research the [GitHub unassigned issue trackers for all the projects](../introduction/projects.md)
5. Introduce yourself on our `#general` slack channel. You can join our Slack Channel using the link on the [Palisadoes Foundation GitHub Home Page](http://github.com/PalisadoesFoundation).
5. Introduce yourself in our [Community Forum](https://community.talawa.io/)
6. If you do not see any interesting projects from the proposed ideas or issues, we encourage you to contact the Palisadoes Foundation’s mailing list and propose a new idea. The Palisadoes Foundation does not encourage and will not respond to your personal new open source project ideas which are unrelated to any Palisadoes projects.
7. You can subscribe to our list at [https://www.freelists.org/list/palisadoes](https://www.freelists.org/list/palisadoes).

Expand Down
Loading