Contents
Where does the Core Team fit in?
Where do project Reviewers fit in?
How do we contribute to a project?
What is Women Who Code?
Women Who Code is a global nonprofit dedicated to inspiring women to excel in their engineering careers. For more information visit Women Who Code
Where does the Core Team fit in?
We have setup a core team within WWCode. The purpose of the core team is to establish visibility and alignment of our tech projects that address the vision and mission of Women Who Code.
Visibility
Being opened sourced, having clear documentation and highlight contributors on current and upcoming project work.
Alignment
Seeking input from contributors, members and organizational leaders on current and upcoming project work.
Goals
Our goal is to have a technically diverse team comprised of people with domain knowledge in software development, data science, analytics, design, project management and product management.
Members
Vinu, Zassmin, Kaitlyn, Sinead
Where do project Reviewers fit in?
We encourage each contributor to review Pull Requests and make valuable comments.
Reviewers are people who review pull requests for each of our projects and give valuable feedback. Reviews are contributors who have agreed to review pull requests within 24hrs, have been contributing to the repository for a longer term and have a larger overall understanding of the code base. Reviewers give a final thumbs up before a Pull Request is merged.
Reviewers are found in repository READMEs.Featured Repos
We are actively working on the following repos:
Website
This is an application we build to communicate what we do to the world, manage our leadership tools, and member experience. Specifically, our website includes blogging system, events system, resources tool, and job board.- Stack: Ruby on Rails, Postgres and runs on Heroku.
- Site: https://www.womenwhocode.com/.
- Repo.This is private and you will get a 404 error. Email core-team@womenwhocode.com if you want to join.
Android App
Member facing app so members can communicate with other members and join events. Currently a prototype.- Stack: Android, Java, and will soon use website as the API.
- Repo
Swift App
Member facing app so members can communicate with other members and join events. Currently a prototype. It is not yet ready for contribution. We will announce when it is ready.- Stack: Swift, Cocopods, and will soon use website as the API.
- Repo
General Repos
- We will list them soon
Deprecated Repos
- API
How do we contribute to a project?
Our projects are open sourced, if you are new to open source please review the below general contributing guides to open source for any project.
Website, Private Repo - Run under Open Source License
Website will be available publicly soon. Until then, please send core-team@womenwhocode.com your github username and tell us a little about your coding experience in Ruby on Rails. Please feel free to share your github repository links that talks about your experience/work.
Want to help out? Great!
- Review our open issues in one of our repositories and see what we are working on. When you decide what to work on, mention directly in the issue that you are working on it. If it looks like a WIP with no pull request or commits linked then feel free to check in with that issue by commenting. Sometimes issues go stale .
- Read the README , before getting started for any helpful tips.
- Sign Up for the Slack Group to discuss issues with fellow developers and contributors and introduce yourself, we love new people .
- If for any reason, you don’t finish the issue, please push your work, mention the branch in a comment on the issue. This will make it easy for the next contributor to pick up. And remember to un-assign yourself.
Identifying Priority Issues
We want to make it easier for our contributors to identify priority issues, as a result we’ve started a weekly milestones(Sprint). This also means, we will prioritize issues in the weekly milestones more quickly for release. And of course, we will recognize you through our weekly Maker Bytes.
How are priority issues identified?
Core-team reviews the WomenWhoCode product roadmap and creates weekly milestones(Sprint). There are various labels to help contributors pick the feature that they have the expertise to do and the time to put in.
Milestone Format:
Mon xxth - yyth YYYY Sprint --- Eg: Apr 23rd-29th 2016 Sprint
Each of the issues may have various label describing the following:
- Feature type: JobBoard, Networking etc.,
- The estimated size of the feature: small, medium, large
- Labels describing the type of feature you are working on Frontend, backend, product love
- Even more minor details describing whether is it html / css, javascript, database etc.
We like feedback and only know how to improve when you tell us what’s good or what could be better. Feel free to send suggestions to core-team@womenwhocode.com or ping us on slack.
Did you find an another interesting issue that is currently not a part of the milestone?
- Check whether the issue is already in our issues list. If not, please create the issue with details
- Comment stating you are working on this issue for the current sprint cc/ @womenwhocode/core and start working on the issue.
The core-team will review the issue and will let you know if there are any blockers in proceeding with the issue. Please note, we will prioritize the review of issues that are in the milestone.
Contributing Policy
Going Inactive
If inactive for 3 months you will be removed from the WomenWhoCode Github Repository and Slack Group . It’s simply meant to make it easier on us to keep track of who is active. Plus, it might be unnecessary noise for you. When you are ready to start contributing again, please check back with us!
Culture
We enjoy building products our members love. This means, we pay attention to detail, care about what we build and look forward to improve it every day. We welcome positive and constructive feedback and encourage contributors to feel the similarly.