Skip to content

Conversation

@sarina
Copy link
Contributor

@sarina sarina commented Dec 11, 2013

Comments welcome from ANYONE! This pull request updates our main CONTRIBUTING.md file to be more clear about what potential open source contributors to edx-platform need to do in order to contribute, as well as sets out expectations for both contributors and edX engineering.

@singingwolfboy @jtauber can you take a look here and tell me what you think?

@carsongee would you mind also taking a look and letting me know what might be missing or is unclear from your perspective?

CONTRIBUTING.md Outdated
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mention one or two IRC resources here: webchat.freenode.net is particularly useful for people who just want to get on IRC as quickly as possible.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you give me some examples? I don't really know IRC well either... I just use a webclient that Julia invited me to.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IRCHelp is a good resource. For clients, the webchat is easiest, because you don't need to install anything and it's cross-platform. ChatZilla is almost as easy -- it's a Firefox extension, and works anywhere Firefox does. For an installed application, Pidgin works decently (or Adium on Mac), and has a familiar instant-messenger-style interface. For something truly dedicated to IRC, there's mIRC for Windows (free), LimeChat for Mac (free), or Textual for Mac (paid). There are also many other clients out there, but those are some good recommendations for people relatively new to IRC.

@singingwolfboy
Copy link
Contributor

This is AWESOME, and super helpful! Thanks, @sarina!

@carsongee
Copy link
Contributor

👍 This is a really nice step forward. It is much appreciated!

@sarina
Copy link
Contributor Author

sarina commented Dec 11, 2013

Thanks for the reviews, everybody!

I'm going to wait to merge this until James has a chance to review things (we may need to discuss the concept of open source community managers more fully).

CONTRIBUTING.md Outdated
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

JavaScript coverage is included in the coverage report (and should also be 95% or greater).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that this seems good.

@sarina sarina mentioned this pull request Dec 12, 2013
@jtauber
Copy link
Contributor

jtauber commented Dec 12, 2013

👍 from me

NOTE: Originally, the intention was that https://github.com/edx/edx-platform/wiki/How-To-Contribute would contain the contribution guidelines. I'd recommend either (1) copying your CONTRIBUTING.md content into the wiki page; (2) changing the wiki page to just link to CONTRIBUTING.md just so we don't have two documents that are out of sync.

sarina added a commit that referenced this pull request Dec 12, 2013
Update CONTRIBUTING.md to be more comprehensive
@sarina sarina merged commit 64ec4e0 into master Dec 12, 2013
@sarina sarina deleted the sarina/update-contributing-docs branch December 12, 2013 22:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

10 participants