Skip to content

Latest commit

 

History

History
46 lines (40 loc) · 3.35 KB

howToContribute.md

File metadata and controls

46 lines (40 loc) · 3.35 KB
Raw

Contribute to the WWCNYC Algorithms group!

This repo and these events are curated, crafted, and cared for by coders like you. We are actively looking for new contributors who identify as women, trans, or genderqueer, who can help share their knowledge of programming with others. If this sounds like you, read on!

Things we LOVE:

  • New problems! They should be language agnostic, vary widely in difficulty, and should take between 5-20 minutes to complete. We aim to have about 6 problems per event, with level 1 being the easiest and level 6 being the hardest. If you submit a problem, please consider submitting one solution as well in either pseudo code or the language of your choice. Consider adding your estimation of difficulty if you'd like.
  • New solutions! We accept all levels of optimization and all languages. Consider adding tests for bonus points :)
  • New tests! Add tests to solutions you submit or existing solutions in a testing folder within the solutions folder. Please update the README.md within the testing folder on how to set it up and run the test(s).
  • Presenters! Do you have a 5-15 minute talk that could help someone ace their next interview or come one step closer to mastering algorithms or data structures more generally? Talk to one of our volunteers and pitch us your idea.
  • Tutors and in person volunteers! We need folks to do everything from help people check in, to find the bathroom, to tutoring and supporting our fellow coders. If one of those roles sounds exciting to you, talk to a volunteer!
  • Free resources! They go in our main readme

Contributing Problems and Solutions to the Repo!

Checkout our latest and greatest GitGuide to walk you through submitting your first pull request with your contribution! Take note! At the moment we generally structure and namespace our files like so:

├── Algorithms (top folder)
	├── gitGuide.md
	├── howToContribute.md
	├── Day-Month-Year.md (date of next algorithm event, markdown file with links to problems)
	├── pastEvents (folder)
		├── Day-Month-Year.md (date of past algorithm events, markdown files with links to old problems)
	├── challenges (folder)
		├── NameOfProblem (folder)
			├── NameOfProblem.md (markdown file with description of the problem)
			├── solutions (folder)
				├── NameOfProblem.js (solutions files in various languages)
				├── NameOfProblem.py
				├── NameOfProblem.rb 
				├── testing (folder)
					├──(any testing files you may need!)

It'd be cool if you can do the same. But if not we will work with what we got.

New to git?

Git and GitHub allow us to collaborate on projects without ever worrying about losing our work (or our minds). Think google docs but with better version control.

To get started here are a few free tutorials/readings:

And of course feel free to ask your peers and the volunteers for help!