v2.ocaml.org icon indicating copy to clipboard operation
v2.ocaml.org copied to clipboard

Outreachy Applicants

Open patricoferris opened this issue 3 years ago • 125 comments

This issue is to track interested Outreachy applicants especially as they try to find ways to contribute to this project. If you are thinking of applying or contributing then in advance let me say thank you!

Important Updates (13/04/2021)

Thank you for all of the wonderful contributions, we've had many, many applicants. To help the mentors (including myself) support all of you, tomorrow morning we will be closing applications for the "Improve OCaml.org" project. I believe you can start an application before getting a contribution in, so if you are genuinely interested make sure you add your application soon.

The other two projects will remain open for the time being.

Thanks :))

Important Updates (06/04/2021)

First of all, thank you for all the enthusiasm and contributions to this repository. The last week alone we've had over 60 new issues (90 active ones) and 22 merged PRs (45 active ones). We are also learning more about the management of Outreachy and have some important updates:

  • The main "mentors" (@pitag-ha, @gs0510 and myself) are available primarily Monday-Friday 10h00-18h00 CET. This should help manage your expectations for when to receive replies etc.
  • As more and more people arrived, being able to assign good-first-issues became an impossible task. A good first issue is meant to help onboard new people. As the name suggests, you should only do one good first issue when you arrive here. This makes it fairer for people arriving later. We missed a few people doing more than one, and that's on us, apologies.
  • Increasingly, people have been submitting their own issues. This is great and we wouldn't want it to stop! However, we are now asking you to limit the number of simpler issues you create (say 2 or 3 max). We need to try and help everyone and dealing with lots of small issues is still time-consuming. This is actually something mentioned in the Outreachy FAQ if you are interested. Please don't take this as asking you to stop submitting, but a well-crafted issue is just as impressive as a PR. When creating an issue please also add why you think the change is an improvement not just just what the change is. Other things to bear in mind as well are: how does it impact other pages, what does it look like on different screen-sizes etc.

This thread is getting long and so some important information is getting lost such as:

  • https://github.com/ocaml/ocaml.org/issues/1245#issuecomment-809623832
  • https://github.com/ocaml/ocaml.org/issues/1245#issuecomment-810217825 (please react to this if you haven't done so already!)

Overview

Outreachy is a program to help people contribute to open-source projects through internships. The Outreachy program is comprised of the Outreachy organisers who run the program, and multiple FOSS community coordinators and mentors. OCaml, and in particular ocaml.org, is participating this year. Our page on Outreachy has more information.

As part of this process applicants are asked to contribute to the project in a small way during the application process as a way to demonstrate their interest.

To facilitate this, issues labelled good-first-issue are ideal for potential candidates.

Registering Interest

Creating and managing issues can be time-consuming and when multiplied by the number of candidates and helping on-going contributors the rate of creating them can drop.

Please, if you are interested in helping but don't have an issue, leave a comment here and we will try to aid you in making a contribution.

The eagerness to contribute is very refreshing, however, we also don't want to place undue pressure on anybody who has already taken on an issue and is tackling the problem. Some issues go stale, but giving people less than a week to make a contribution after they have registered interest isn't the best option. Hence this issue to track and mange interest was created.

If you see an unclaimed issue (a good-first-issue or otherwise) feel free to register your interest in tackling the problem directly on that issue without adding comments here.

Contributing

Myself and some other maintainers of this site are more than willing to help anyone with contributing, but please appreciate that some times this takes a bit of time.

We are in the process of creating a new contributing document which should help you get started. Please use that PR to discuss any problems getting started.

If you have any other questions please leave a comment below.

Thanks again for your interest and we look forward to working with you 🐫

patricoferris avatar Mar 03 '21 11:03 patricoferris

Thanks @patricoferris . What is the general code review process like here? After creating a PR, I couldn't request a review from a core contributor.

nibble0101 avatar Mar 03 '21 11:03 nibble0101

Hey, I wanted to participate in outreachy. I went through the good-first-issue label, but the three issues under the label seem to be resolved, so, it would be great if you could suggest me something I can work upon. :) I have a firm knowledge of HTML, CSS and Javascript and I am currently going through the ocaml documentation.

Aditi-1400 avatar Mar 05 '21 16:03 Aditi-1400

I want to participate in outreachy and I am very eager to contribute early. So can you please provide me some tasks, that can help me to understand the codebase?

gunjan543 avatar Mar 05 '21 16:03 gunjan543

@nibble0101 as you can see the review/PR process is slow, there's lots of exciting things happening in the OCaml space at the moment but only so many of us. We should get around to reviewing PRs within a week of submitting them. Feel free to ping me on the PR after that if it still hasn't had any eyes on it!

@Aditi-1400 @gunjan543 great! I'll find something in the coming days. I noted from the Outreachy website that the initial contribution period is:

March 15, 2021 to April 16, 2021

and so far we've already had quite a few applicants contributing which is great but also more than we expected! So I need a little time to think of some good issues :))

In the first instance, however, getting the site building and providing feedback on this PR is a really helpful and worthwhile task (any Outreacy applicant can comment on that PR with their experience and thoughts). Thank you for your patience and enthusiasm 🐫

patricoferris avatar Mar 05 '21 16:03 patricoferris

Sure, I'll definitely provide a feedback, and in the meanwhile, I'll just go through the code base. :)

Aditi-1400 avatar Mar 05 '21 16:03 Aditi-1400

I had few suggestions regarding ocaml.org, so can I suggest some modifications or changes to that?

gunjan543 avatar Mar 05 '21 16:03 gunjan543

hello, I'm expecting outreachy in summer '21. I went through the OCaml documentation and issues, but there are only a few of them and all of them seem to be almost resolved. I would love to work and give my contributions to OCaml this summer. if I could get some good issues to work upon that would be great. I want to get familiar with the codebase and how the community works, well before the contribution period starts.

looking forward to a good community bonding :)

yashi-hub avatar Mar 08 '21 06:03 yashi-hub

@gunjan543 Yes of course, your suggestions are more than welcome. Creating easily understandable issues is probably the best way to solicit some feedback and if it gets some approval a PR would be great!

@yashi-hub Welcome 🐫 ! Yes, I'm working on it today, as I've said in this thread in the meantime getting the site building locally is a great first step and providing feedback to the contributing PR would be great! Not all contributions have to be code, your feedback is extremely valuable in helping others contribute :))

patricoferris avatar Mar 08 '21 09:03 patricoferris

Hi Team,

I am also a potential outreach applicant waiting for the results of the initial application. I have already gone through the code and have spotted few bugs, hoping to have great summer with OCaml 😄

meenal06 avatar Mar 09 '21 10:03 meenal06

Hi, I would like to make contributions for #1254. Hoping to work as an outreachy intern this summer for OCaml.

Kanak1081 avatar Mar 11 '21 06:03 Kanak1081

Hey, @Kanak1081, I am actually working on #1254 and I am almost done with it and you wouldn't want to duplicate the work, right! :)) So maybe you could try working on an unattended issue or wait for @patricoferris to assign you one :)

Aditi-1400 avatar Mar 11 '21 07:03 Aditi-1400

Hi @patricoferris, hope you are doing great. I would like to contribute in an issue related to frontend programming. Can you help me assign one?

Kanak1081 avatar Mar 11 '21 08:03 Kanak1081

Hey, @Kanak1081, I am actually working on #1254 and I am almost done with it and you wouldn't want to duplicate the work, right! :)) So maybe you could try working on an unattended issue or wait for @patricoferris to assign you one :)

Sure @Aditi-1400 Please go ahead. All the best ! :)

Kanak1081 avatar Mar 11 '21 08:03 Kanak1081

Hi @Kanak1081 thank you for wanting to contribute 🐫 ! I'll get an issue sorted for you soon (if not this evening then tomorrow morning). Sorry for the delay.

patricoferris avatar Mar 11 '21 17:03 patricoferris

Hey @patricoferris, if it's okay then I would like to open some new issues. May I?

nayaldivya avatar Mar 12 '21 11:03 nayaldivya

Hello @patricoferris, Hope you are doing amazing. I am a potential outreachy applicant '21. Would love to work on some frontend related issues and get to know the community better. Thanks in advance!

jyotibalodhi avatar Mar 12 '21 14:03 jyotibalodhi

Hello @patricoferris. I am here as an outreachy applicant'21. Hope everyone is doing great. (I already see so many potential applicants. Hello everyone.) I would also like to work on some issues. I ll try to find something in issues tag. But if you see a potential good first issue please tag me. (^_^)/ Thnx in adv

anshukaira avatar Mar 16 '21 12:03 anshukaira

Hi @patricoferris, Hope you are doing great. I'm also a potential outreachy applicant '21. I'm going through the documentation of OCaml and learning some new stuff. It would be great if you can tell how should I start reading the codebase and if you can assign any frontend related issue I would love to work on that as well. Thank you :)

lead4013 avatar Mar 16 '21 16:03 lead4013

Hello @patricoferris and other contributors. I hope everyone is doing well. As an outreach applicant for 2021, I would like to contribute to Ocaml. @patricoferris It would be really great if you help me in finding new issues as most of the issues are already assigned or solved. I have a basic knowledge of Ocaml and I am learning more about Ocaml. Please help me in finding some issues. Thank You.

divya144 avatar Mar 20 '21 15:03 divya144

Hi @patricoferris , I'm also an outreachy applicant for 2021. I am looking forward to make contributions for #1246 . Hoping to work for Ocaml as an Outreachy'21 intern and have a great time with the mentors and fellow contributors. Thanks in advance!

Muskan-sam avatar Mar 20 '21 16:03 Muskan-sam

Hello @patricoferris, I realize you seem to have a lot of issues to find already. This is my first go at open-source and would appreciate it if you assign me an Issue as well. Thank you

shlokalakka avatar Mar 22 '21 19:03 shlokalakka

Hi @patricoferris , I'm an outreachy applicant for 2021. I want to make contributions tor #1246 . Hoping to work for Ocaml as an Outreachy'21 intern and have a great experience and time with the mentors and fellow contributors. Thanks you!

IkehAkinyemi avatar Mar 27 '21 21:03 IkehAkinyemi

Hi @patricoferris, I am an Outreachy applicant interested in working on improving the ocaml.org website. Currently working on issue #1308

Goodiec avatar Mar 29 '21 16:03 Goodiec

Hi @patricoferris I'm an outreachy applicant and I'm interested in 2 projects under OCaml organization. The projects are "Improving the ocaml.org website" and "Add templating to the OCaml documentation generator". It would be great If you can assign any relevant issue to me. Thanks :)

mahakbansal2019 avatar Mar 29 '21 16:03 mahakbansal2019

Hi everyone 👋

Let me first say how grateful and excited I am to see so many new people want to help and contribute to the OCaml community! Thank you.

I appreciate that now the Outreachy contribution period has officially begun and people will want issues. We're adding issues and helping people to the best of our abilities. @pitag-ha is also helping and whenever possible @avsm :))

Issue Assignment

Regarding being "assigned" an issue let me reiterate a few points. You do not need to be "Github assigned" an issue to work on it, you only need to register that you are interested or working on it on the issue itself. This comes with one really important caveat, make sure someone else hasn't within the last 7 days also registered interest. To quote myself from above:

The eagerness to contribute is very refreshing, however, we also don't want to place undue pressure on anybody who has already taken on an issue and is tackling the problem. Some issues go stale, but giving people less than a week to make a contribution after they have registered interest isn't the best option.

We are trying to offer a friendly and helpful environment for people to feel comfortable when submitting PRs, raising issues etc. Adding extra pressure by asking for an issue when someone else is already working on it is not that environment.

Pinging me on the issue asking to do it when someone has already said they are is it not in the spirit of open-source. A better approach could be to (a) ask the person if they need some help (after they've had the issue for a while not immeadiately) and (b) ask me on this issue if you want a good-first-issue so as to not put any pressure on other people.

Other forms of Contribution

There's absolutely nothing wrong with anyone opening an issue too. If you think you've found a bug please do and you can also submit a PR for it after we've discussed it in the issue. There's already been some excellent examples of this.

In addition to this, not all contributions have to be code. The CONTRIBUTING.md document needs a lot more work so if you feel you have some good ideas I would love to hear them (e.g. setting up a Windows environment using WSL, better explanation of the build process etc.)

Again, thank you for all the enthusiastic messages and eagerness to contribute. I look forward to helping you contribute to open-source OCaml projects :))

patricoferris avatar Mar 29 '21 18:03 patricoferris

Hello @patricoferris, I am an Outreachy Summer 2021 applicant, and I am interested in contributing to OCaml. I am a first-time open source contributor and am excited to have the opportunity to learn and contribute to OCaml's website.

I have looked at the first time issues list, but there are no current available issues to work on. Please let me know if there is an available issue for me to work on. I am looking forward to being able to contribute to OCaml!

kaniaganda avatar Mar 30 '21 03:03 kaniaganda

Hello @patricoferris, I am an outreachy applicant, I would love to work on issues related to frontend technologies and learn about other tools and technologies that can help me understand and contribute to this project better. I am looking forward to working with all the mentors and community members. Currently I am working on #1306 ! Also, kindly tag me if you come across any issue that might help me work on my skills of frontend development. Thanks in advance! :)

jyotibalodhi avatar Mar 30 '21 04:03 jyotibalodhi

Hi @patricoferris , I am an outreachy applicant. I searched some 'good first issues' but every issue has already been assigned to someone else. Please help me out with this. Thank you in advance! :)

gurleennsidhuu avatar Mar 30 '21 05:03 gurleennsidhuu

Hello @patricoferris I'm having issues with building the site. Where do I ask for help?

I've installed opam and cloned the Ocaml codebase but when I try to build with make it returns this:

/Library/Developer/CommandLineTools/usr/bin/make staging SET_STAGING='-set staging'
cd script && \
    ocamlfind ocamlopt -annot -g -safe-string -package cohttp-lwt-unix,netstring,syndic \
      -thread -linkpkg utils.cmx http.ml rss2html.ml -o ../"script/rss2html"
File "http.ml", line 38, characters 4-22:
38 |   | `Resume_incomplete (* actually 308 Permanent Redirect *)
         ^^^^^^^^^^^^^^^^^^
Error: This pattern matches values of type [? `Resume_incomplete ]
       but a pattern was expected which matches values of type
         Cohttp__.Code.status_code
       The second variant type does not allow tag(s) `Resume_incomplete
make[1]: *** [script/rss2html] Error 2
make: *** [local] Error 2

TildaDares avatar Mar 30 '21 07:03 TildaDares

Hello @patricoferris I'm having issues with building the site. Where do I ask for help?

I've installed opam and cloned the Ocaml codebase but when I try to build with make it returns this:

/Library/Developer/CommandLineTools/usr/bin/make staging SET_STAGING='-set staging'
cd script && \
    ocamlfind ocamlopt -annot -g -safe-string -package cohttp-lwt-unix,netstring,syndic \
      -thread -linkpkg utils.cmx http.ml rss2html.ml -o ../"script/rss2html"
File "http.ml", line 38, characters 4-22:
38 |   | `Resume_incomplete (* actually 308 Permanent Redirect *)
         ^^^^^^^^^^^^^^^^^^
Error: This pattern matches values of type [? `Resume_incomplete ]
       but a pattern was expected which matches values of type
         Cohttp__.Code.status_code
       The second variant type does not allow tag(s) `Resume_incomplete
make[1]: *** [script/rss2html] Error 2
make: *** [local] Error 2

Thank you @patricoferris your solution worked. If anyone else has this problem try this: https://discuss.ocaml.org/t/error-while-setting-up-ocaml-project-using-wsl/7466/7

TildaDares avatar Mar 30 '21 08:03 TildaDares