Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Call for contributors! #1347

Closed
sebmck opened this issue Apr 24, 2015 · 29 comments
Closed

Call for contributors! #1347

sebmck opened this issue Apr 24, 2015 · 29 comments
Labels

Comments

@sebmck
Copy link
Contributor

@sebmck sebmck commented Apr 24, 2015

So Babel has become a pretty big beast. I'm looking for contributors. Right now contributions have been pretty inconsistent. Don't get me wrong, I love and appreciate all contributions but at the end of the day I'm still maintaining Babel and attend to the majority of the bug fixes and new features. This can become incredibly stressful and in the interests of my personal free time and sanity I'd like for that to change.

Where can I contribute?

Documentation/Website

Seriously, this is mega-important. The documentation so far has been great and has been a killer feature of Babel. There are sections that could certainly use some work and even the addition of a paragraph here or there is extremely appreciated.

If you have any free time and you see areas of the documentation that you think can be improved please submit a pull request. See the babel.github.io repo for the website source.


Work on Babel core

Feel free to ping me on slack if you have any specific internal questions. I'll be looking into doing some screencasts on the internals and/or blog posts to ease the transition into the code base for newcomers.

If you're looking to dive in and fix something, consider picking from the list of issues labeled good first bug.

Note about pull requests

Please note that before any significant contributions (feature additions etc) I'd love if an issue was open prior discussing what it is you want to do. There's nothing worse than having to turn down a PR if it could have been avoided prior to all the effort being put in.

Optimisations

This is an area that hasn't really been given much love since @gaearon did some V8 optimisations.

The code generator is an area that needs a lot of work, it takes exponentially longer the larger the source file is, this is crap. Files that are megabytes or hundreds of kilobytes should not take a million years to generate. This will be especially important moving forward as Babel becomes a more general JavaScript transformer.


Respond to issues

Responding to issues is another extremely effective way to help out. I've been trying to keep support and questions out of GitHub issues, even though the README is literally 3 lines, some people don't seem to read it. Pointing these people in the right direction (eg. to slack, website repo, StackOverflow etc) is extremely appreciated.


Answer questions on slack

Babel has an incredibly active slack channel. Slack has an IRC bridge as well as a range of apps which makes idling and answering questions super easy.


Anything else!

Seriously, any contributions are appreciated.


Thank you in advance to anyone who helps out!

💅

@sebmck
Copy link
Contributor Author

@sebmck sebmck commented Apr 24, 2015

Also here are the slides from a recent talk I did where I scratched the surface of the Babel architecture. Some of it may be a bit confusing without the accompanying audio but hopefully it gives a good basic overview :)

@sebmck sebmck added the discussion label Apr 24, 2015
@sebmck
Copy link
Contributor Author

@sebmck sebmck commented Apr 24, 2015

A quick shoutout to all the awesome people who've helped out so far! @gaearon @RReverser @#2neVERberleRfellerER @eventualbuddha @webpro @AluisioASG @monsanto @sindresorhus Thank you so much!

Separate shout out to @thejameskyle who made the awesome babejs.io website and who's been invaluable to Babel community outreach and management. Seriously, thank you. ❤️

@bloodyowl
Copy link

@bloodyowl bloodyowl commented Apr 24, 2015

I just started to watch the repo to be able to answer to new issues.
I might also work a bit on the core if needed.

you_have_my_sword

@monsanto
Copy link
Contributor

@monsanto monsanto commented Apr 25, 2015

@sebmck Thanks for the shoutout. Honestly I wanted to help out more in the beginning, but the project was moving so quickly that I was afraid the internals were going to completely change by the time I was done with a fix/feature/whatever. Totally a compliment btw 😛

I've been responding to issues for a while, I could help with tagging/closing stuff if you want?

@MylesBorins
Copy link
Member

@MylesBorins MylesBorins commented Apr 25, 2015

I started watching the repo... I'll see what I can do to help out!

@sebmck
Copy link
Contributor Author

@sebmck sebmck commented Apr 26, 2015

@monsanto

Honestly I wanted to help out more in the beginning, but the project was moving so quickly that I was afraid the internals were going to completely change by the time I was done with a fix/feature/whatever

Main reason is that I had no idea what I was doing as this has all been a learning exercise for me. I didn't know how to architect something like but it's now in a stable place and the internal architecture is extremely unlikely to change and any major changes will be discussed in an issue beforehand.

I've been responding to issues for a while, I could help with tagging/closing stuff if you want?

Sounds good to me 😄

@thealphanerd Rad, thanks!

@torifat
Copy link

@torifat torifat commented Apr 26, 2015

I'm in 😄 since I'm using babel for my React codes.

@zcei
Copy link

@zcei zcei commented Apr 27, 2015

Started watching and looking forward for some contribution!

Will start of with issues / docs to get used to the source, then I'd love to contribute some code where needed.

Awesome lib so far, let's keep up the good work together 👍

@loganfsmyth
Copy link
Member

@loganfsmyth loganfsmyth commented Apr 27, 2015

Mostly trying to help in Gitter, but also watching and trying to help with opened issues when I can. Will try to do more as time allows. :D

@jquense
Copy link
Contributor

@jquense jquense commented Apr 27, 2015

Watching! will try to help where I can, hope you can get some rest and space to do other things

@ameyms
Copy link

@ameyms ameyms commented Apr 29, 2015

I tried going through the slides, but I found it difficult to understand without audio.
@sebmck - Maybe you could have a "good-first-bug" label? That ways, people new to the codebase can start squashing bugs that might be trivial to you and in that process gain more insight into the codebase.

@lukescott
Copy link
Contributor

@lukescott lukescott commented May 1, 2015

@sebmck, first off I want to say you've done an amazing job. It's rare to see a project with such a low open to close issue ratio. Currently 20 open issues out of 1,150. That is 1% of the total issues. That is amazing! Many well maintained projects with several contributors are around 20%. And you do this in your free time!? Dude, you are a rock star! I can't express enough the appreciation I have for this project!

Most of what I've contributed thus far has impacted me directly with a work project. I don't have much in the free time department yet, but I want to contribute in any way that I can.

@boopathi
Copy link
Member

@boopathi boopathi commented May 7, 2015

I'm using it for all my projects. I'm in.

@mithun-daa
Copy link

@mithun-daa mithun-daa commented May 8, 2015

The starter videos would help immensely.

@vnovick
Copy link

@vnovick vnovick commented Jun 2, 2015

started to watch repo. Count me in :) I'm using babel for my projects, so will gladly contribute

@benjamingr
Copy link

@benjamingr benjamingr commented Jun 7, 2015

I'm going to mention this issue in a talk I'm giving, so I apologize in advance if people show up :) Hopefully. I think an internals guide would go a huge way to help - as well as a tutorial on writing a transformer.

@jmm
Copy link
Member

@jmm jmm commented Jun 8, 2015

I'm finding the babel code base rather difficult to get up to speed with. I've looked at the slides and they're not much help. More documentation about the architecture would be helpful, as would more comments in the source code. Do you have any plans to add a lot of comments to the source anytime soon, and would you be open to PRs for that?

@sebmck
Copy link
Contributor Author

@sebmck sebmck commented Jun 8, 2015

There are already a bunch of method JSDoc comment placeholders that I’m planning on filling in. Most of the code is fairly self-documenting and the codebase is always going to be difficult to get into if you don’t already understand the core concepts (ASTs etc).

On Mon, Jun 8, 2015 at 2:02 PM, Jesse McCarthy notifications@github.com
wrote:

I'm finding the babel code base rather difficult to get up to speed with. I've looked at the slides and they're not much help. More documentation about the architecture would be helpful, as would more comments in the source code. Do you have any plans to add a lot of comments to the source anytime soon, and would you be open to PRs for that?

Reply to this email directly or view it on GitHub:
#1347 (comment)

@sebmck
Copy link
Contributor Author

@sebmck sebmck commented Jun 8, 2015

Also thanks everyone for your kind words and interest in contributing! In the coming weeks i'll hopefully be able to put together better contribution guides and architecture documents. I've recently created a Babel Slack to foster of a "Babel Community", so if you're still interested in helping out then I'd recommend getting on the slack and joining #development, I'm more than happy to organise collaboration/contribution and to answer architectural questions.

@jmm
Copy link
Member

@jmm jmm commented Jun 8, 2015

There are already a bunch of method JSDoc comment placeholders that I’m planning on filling in.

👍

Most of the code is fairly self-documenting

That hasn't been my experience so far. Possibly you're overestimating this effect.

and the codebase is always going to be difficult to get into if you don’t already understand the core concepts (ASTs etc).

Understood, but that's not the only issue.

@sebmck
Copy link
Contributor Author

@sebmck sebmck commented Jun 8, 2015

That hasn't been my experience so far. Possibly you're overestimating this effect.

Well yeah, I'm obviously a bit biased 😛

Understood, but that's not the only issue.

Can you elaborate then?

@jmm
Copy link
Member

@jmm jmm commented Jun 8, 2015

Can you elaborate then?

A lot more source code comments is really obvious, low-hanging fruit. Currently, even just looking at a single file and trying to understand what the methods do and how they interact is a pain. It gets worse when you start trying to connect the dots between files. That's a lower-level problem than understanding concepts like ASTs.

Take this file for example. I don't think there's so much as one method that has a description or notation about return value. That creates a lot of friction for gaining an understanding of the code base.

@sebmck
Copy link
Contributor Author

@sebmck sebmck commented Jun 8, 2015

Ah yeah, that's true. I've never maintained a large open source project before and have always worked independently so this is all a learning experience for me 😄 I appreciate the constructive criticism and will work on improving internal docs and code structure.

@jmm
Copy link
Member

@jmm jmm commented Jun 9, 2015

@sebmck

Ah yeah, that's true. I've never maintained a large open source project before and have always worked independently so this is all a learning experience for me 😄 I appreciate the constructive criticism and will work on improving internal docs and code structure.

Awesome, thank you! If you want I can try PR'ing source comments if / when I figure those kinds of things out.

@vtambourine
Copy link

@vtambourine vtambourine commented Jun 22, 2015

Feel free to ping me on gitter..

Please, change link to gitter chat with slack chat in the desription.

@eventualbuddha
Copy link
Member

@eventualbuddha eventualbuddha commented Jun 22, 2015

@vtambourine I updated the initial comment to refer to Slack instead of Gitter. Thanks for pointing that out.

@jmm
Copy link
Member

@jmm jmm commented Jun 22, 2015

@eventualbuddha Would probably also be good to mention the good first bug label in the initial comment, if you feel like making the edit.

@eventualbuddha
Copy link
Member

@eventualbuddha eventualbuddha commented Jun 22, 2015

@jmm done.

@jmm
Copy link
Member

@jmm jmm commented Jun 22, 2015

@eventualbuddha Thanks.

@sebmck sebmck closed this Sep 1, 2015
@lock lock bot added the outdated label Jul 12, 2018
@lock lock bot locked as resolved and limited conversation to collaborators Jul 12, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
You can’t perform that action at this time.