Skip to content

Commit 511dcd0

Browse files
jaimergpviniciusdc
andcommitted
add blog/2021-02-02-Outreachy.md
Co-authored-by: viniciusdc <[email protected]>
1 parent 3e549e5 commit 511dcd0

File tree

1 file changed

+188
-0
lines changed

1 file changed

+188
-0
lines changed

blog/2021-02-02-Outreachy.md

Lines changed: 188 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,188 @@
1+
---
2+
authors:
3+
- viniciusdc
4+
tags: [outreachy]
5+
---
6+
7+
# Conda-forge Outreachy
8+
9+
Conda-forge is participating in the upcoming round of
10+
[Outreachy](https://www.outreachy.org/) i.e May 2021 to August 2021. The
11+
goal of this program is to increase participation from under-represented
12+
groups in free and open-source software. Outreachy is organized by
13+
[Software Freedom Conservancy](https://sfconservancy.org/).
14+
15+
<!--truncate-->
16+
17+
## Participant Application Process:
18+
19+
First, please review the Outreachy Eligibility and Application
20+
Information page to learn more about eligibility for Outreachy.
21+
22+
## Steps for applicants to conda-forge:
23+
24+
1. Confirm your eligibility on the Outreachy site
25+
2. Look at the Conda-forge projects available on the Outreachy site,
26+
consider your options, and if you have questions, communicate with the
27+
project mentors.
28+
3. Begin by contributing to the project by looking at our [issues
29+
page](https://github.com/conda-forge/conda-forge.github.io/issues).
30+
As you make contributions, record them on the Outreachy site.
31+
4. Once you have made a few contributions, begin to write your application.
32+
Ask the mentors to review the application before you submit it.
33+
34+
## Participant Expectations
35+
36+
You will be working full-time on your project for three months. You will
37+
meet with your mentor(s) frequently and participate in the open-source
38+
development process -- writing code, reviewing code, testing, and so
39+
on. You will be expected to write a blog entry each week.
40+
41+
## Project Contribution Information
42+
43+
As part of the application process, all applicants must make at least
44+
one contribution to be accepted as an intern for this project. Only
45+
applicants who make a contribution will be eligible to be accepted as
46+
interns.
47+
48+
While we don't have one we highly recommend the first-time contributor
49+
to be a conda user and/or submit a package to conda-forge via
50+
[staged-recipes](https://github.com/conda-forge/staged-recipes). That
51+
will ensure the contributor understands the value of what we do and
52+
means that they are willing to participate in our community.
53+
54+
Applicants can contribute to this project through the [project
55+
repository or contribution page](https://conda-forge.org/#contribute).
56+
The project uses an [issue
57+
tracker](https://github.com/conda-forge/conda-forge.github.io/issues) to
58+
keep information about bugs to fix, project features to implement,
59+
documentation to write, and more. Applicants can look for
60+
newcomer-friendly issues to use for their first contributions by looking
61+
for the following issue tags in the project issue
62+
[tracker](https://github.com/conda-forge/conda-forge.github.io/issues):
63+
Docs, Good first issue
64+
65+
We here at [conda-forge](https://conda-forge.org/#contribute) have a
66+
large number of potential Outreachy endeavors around documentation,
67+
maintenance, and development. These tasks are high-impact, affecting the
68+
entire conda-forge ecosystem. They also cover multiple systems including
69+
databases, conda's CDN provider, continuous integration providers, and
70+
user interactions on GitHub.
71+
72+
## How do I work with the conda-forge community?
73+
74+
Outreachy applicants can get help and feedback from both mentors and
75+
community members. Community members discuss their contributions in a
76+
public chat. Outreachy applicants can often learn from those
77+
discussions.
78+
79+
Please introduce yourself on the public project chat:
80+
81+
- Gitter - [Follow this
82+
link](https://gitter.im/conda-forge/conda-forge.github.io) to join this
83+
project's public chat.
84+
- Outreachy mentors will often be in the community public chat. The
85+
project mentor's usernames are: `@viniciusdc`.
86+
87+
Here are some ready-to-go ways you can get started contributing on your
88+
own.
89+
90+
- Find an open issue to tackle or report a bug to the issue tracker;
91+
- Don't be afraid to communicate: Ask if you can help write a new
92+
feature or help Automate project setups;
93+
- Improving current tooling and testing features is always welcome.
94+
95+
As this project main goal is enhancing our current documentation, here
96+
are some preliminary tasks that you can inspect to get ideas:
97+
98+
- Write and improve the project's documentation;
99+
- Link to duplicate issues, and suggest new issue labels, to keep
100+
things organized;
101+
- Go through open issues and suggest closing old ones;
102+
- Ask clarifying questions on recently opened issues to move the
103+
discussion forward;
104+
- We also have issues regarding the main functionalities of our bot,
105+
in particular the autotick bot. You could find some new information
106+
or ideas for your contributing proposals.
107+
108+
## Good starter tasks:
109+
110+
### Small Starter Tasks
111+
112+
As with most organizations, there are lots of small issues that need
113+
addressing usually related to problems such as bad recipes, old
114+
documentation and others. These will make good first issues to resolve
115+
or "update". This will also be an opportunity to familiarise yourself
116+
with the conda-forge environment.
117+
118+
### Larger tasks
119+
120+
There are a few potential larger tasks that can come after a few smaller
121+
task contributions. These are included into our three main bases:
122+
123+
- [Users](https://conda-forge.org/docs/user/00_intro.html): In this
124+
case, some good starter tasks are mainly checking the actual
125+
contents of conda-forge users documentations, and ideas to better
126+
express its contents.
127+
- [Maintainers](https://conda-forge.org/docs/maintainer/00_intro.html):
128+
There are a bunch of missed topics in this area, some information
129+
have to be updated or rewritten for better understanding. Writing a
130+
complete guide containing the actual steps and standard model for a
131+
package recipe, building process (just a simple discussion) and how
132+
conda-forge bot recognize defective licenses, recipes and packages
133+
in general is highly welcomed. For further understanding of the
134+
general system check [this
135+
link](https://conda-forge.org/docs/maintainer/infrastructure.html).
136+
- It can be funny to say, but lots of helpful ideas and bug
137+
solutions appear on our gitter channel, so if you have time to
138+
write guides about them... it's also an incredible task.
139+
- [And organization](https://conda-forge.org/docs/orga/00_intro.html)
140+
Our environment is changing everyday, because of that a lot of
141+
information is lost in this process or even worse, not documented at
142+
all! which leads to some difficulties inserting new members to
143+
develop and further enhance the current process.
144+
- The related work on this matter is highly welcomed and for a
145+
better grasp of the situation you can start with this
146+
[guideline](https://conda-forge.org/docs/orga/guidelines.html)
147+
and read some of our posts in our
148+
[blog](https://conda-forge.org/blog/blog/)
149+
- Revitalizing ideas/projects for the conda-forge blog are
150+
definitely welcomed;
151+
- Currently we have some interesting projects going on inside our
152+
ecosystem, which in return will need good documentation... Some
153+
of the projects conda-forge is affiliated include the [auto-tick
154+
bot](https://github.com/regro/cf-scripts),
155+
[symbol-exporter](https://github.com/symbol-management/symbol-exporter)
156+
and a new service we are eager to start developing is the
157+
[distributed-bot](https://github.com/regro/cf-scripts/issues/1367).
158+
All of them have a great coverage of subjects and lots of people
159+
to help and give advice about the service structure and
160+
functionalities.
161+
162+
## Improving the documentation
163+
164+
You can help improve the documentation as it is version-controlled in
165+
the conda-forge.github.io repository on GitHub. The source text is
166+
stored there in the `src/subdirectory` and is formatted using [Python's
167+
reStructuredText system](https://wiki.python.org/moin/reStructuredText).
168+
169+
You can propose quick edits directly through the GitHub website, if you
170+
have an account there --- for instance, this
171+
[link](https://github.com/conda-forge/conda-forge.github.io/edit/master/src/user/contributing.rst)
172+
will take you directly to a web-based editor for this section page in
173+
our
174+
[docs](https://conda-forge.org/docs/user/contributing.html#improve-docs).
175+
In general, the file corresponding to each page in the GitHub browser
176+
has a little pencil icon in its top-right that lets you open it up for
177+
editing.
178+
179+
The more manual process is as follows:
180+
181+
- Fork the conda-forge.github.io repository to your own GitHub user
182+
account.
183+
- Clone that fork onto your computer.
184+
- Check out a new branch deriving from master to do your work.
185+
- Make and commit your changes.
186+
- Submit a pull request to the main repository proposing your changes.
187+
188+
Happy editing!

0 commit comments

Comments
 (0)