# Home ![](/files/-M8KC8-1jAuS1-Ybf-LG) [![All Contributors](https://img.shields.io/badge/all_contributors-6-orange.svg?style=flat-square)](#contributors-) [![Financial Contributors on Open Collective](https://opencollective.com/osca/all/badge.svg?label=financial+contributors)](https://opencollective.com/osca) [![OpenCollective](https://opencollective.com/osca/backers/badge.svg)](#backers) [![OpenCollective](https://opencollective.com/osca/sponsors/badge.svg)](#sponsors) *** **Open Source Community Africa** is for open-source lovers, enthusiasts, advocates, and experts within and across Africa with the sole aim of increasing the rate of credible contributions by African software developers, designers, writers, and everyone involved in the sphere of technology to open source projects both locally and globally, changing the perception of Africans from just the billion users to the **NEXT BILLION CREATORS**. Welcome to our documentation guide for members looking to know more about **Open Source Community Africa** and also make a contribution to any of our projects. To suggest changes, click the GitHub icon on any docs page and make a pull request. If you're unsure how to do that, kindly read the [documentation contribution guidelines](https://docs.oscafrica.org/~/changes/xMDCL5DzAhhQl0q8bjTh/contributing/documentation/guidelines). > PS: This documentation is a work in progress; please be patient with us as we slowly fill up empty pages and add a contribution guideline. Feel free to give us feedback for now. Thank you. If you need any help, please contact us at or join the `#documentation` channel on our [Discord](https://bit.ly/osca-discord) server. Cheers!
## Get Started Want to know more about Open Source Community Africa? Read the following sections: {% content-ref url="/pages/-M8KA-H-6CujrQnFVS8M" %} [Introduction](/about/introduction) {% endcontent-ref %} {% content-ref url="/pages/-M8KA-H3Qj4jal01GZdD" %} [Community Code of Conduct](/about/community-code-of-conduct) {% endcontent-ref %} {% content-ref url="/pages/-M8KA-H0pIjNpC6oz4t9" %} [Terminology](/about/terminology) {% endcontent-ref %} ## Browsing Categories Want to know more about Open Source Community Africa branding guidelines? Read the section below: {% content-ref url="/pages/-M8KA-H1HGrYkdNw1HGK" %} [Branding Guidelines](/about/guidelines) {% endcontent-ref %} Got a question or inquiry? Read Read the section below: {% content-ref url="/pages/-MD\_7OtEPDHDRtAG7leL" %} [FAQs](/about/faqs) {% endcontent-ref %} Want to know more about Open Source Community Africa team? Read the section below: {% content-ref url="/pages/-M8KA-H5RSkFinQpUJvu" %} [Team](/about/team) {% endcontent-ref %} Want to know more about Open Source Community Africa values and processes? Read the section below: {% content-ref url="/pages/-M8KA-H6OO3P25JNVddR" %} [The OSCA Way](/about/the-osca-way) {% endcontent-ref %} Want to know more about Open Source Community Africa community? Read our **COMMUNITY** section: {% content-ref url="/pages/-M8KA-HD8CHK26vFP0b7" %} [COMMUNITY](/community/chapters) {% endcontent-ref %} Want to know more about Open Source Community Africa finance processes? Read the section below: {% content-ref url="/pages/-M8KA-HqQ0oLK9AMok47" %} [FINANCE](/finance/tiers-and-goals) {% endcontent-ref %} Want to know more about Open Source Community Africa partnerships and external OSS programs? Read the section below: {% content-ref url="/pages/-M8KA-HRQn-BdT3G2Doh" %} [OSS PROGRAMS](/oss-programs/osca-open-source-challenge) {% endcontent-ref %} Want to know more about contributing to Open Source Community Africa? Read the section below: {% content-ref url="/pages/-M8KA-HXjNCmbhTw5loj" %} [CONTRIBUTING](/contributing/engineering) {% endcontent-ref %} Want to know more about Open Source Community Africa projects? Read the section below: {% content-ref url="/pages/-M8KA-Hl6kNp4mlA07Jm" %} [PROJECTS](/projects/osca-twitter-bot) {% endcontent-ref %} ## Contact Us If you need more help, please contact us at or join our [Discord](https://bit.ly/osca-discord) server. ## Financial Contributors Become a financial contributor and help us sustain our community. \[[Contribute](https://opencollective.com/osca/contribute)] ### Individuals ![OSCA Financial Contributors](https://opencollective.com/osca/individuals.svg?width=900) ### Organizations Support this project with your organization. Your logo will show up here with a link to your website. \[[Contribute](https://opencollective.com/osca/contribute)] [![OSCA Financial Contributor](https://opencollective.com/osca/organization/0/avatar.svg)](https://opencollective.com/osca/organization/0/website) [![OSCA Financial Contributor](https://opencollective.com/osca/organization/1/avatar.svg)](https://opencollective.com/osca/organization/1/website) [![OSCA Financial Contributor](https://opencollective.com/osca/organization/2/avatar.svg)](https://opencollective.com/osca/organization/2/website) [![OSCA Financial Contributor](https://opencollective.com/osca/organization/3/avatar.svg)](https://opencollective.com/osca/organization/3/website) [![OSCA Financial Contributor](https://opencollective.com/osca/organization/4/avatar.svg)](https://opencollective.com/osca/organization/4/website) [![OSCA Financial Contributor](https://opencollective.com/osca/organization/5/avatar.svg)](https://opencollective.com/osca/organization/5/website) [![OSCA Financial Contributor](https://opencollective.com/osca/organization/6/avatar.svg)](https://opencollective.com/osca/organization/6/website) [![OSCA Financial Contributor](https://opencollective.com/osca/organization/7/avatar.svg)](https://opencollective.com/osca/organization/7/website) [![OSCA Financial Contributor](https://opencollective.com/osca/organization/8/avatar.svg)](https://opencollective.com/osca/organization/8/website) [![OSCA Financial Contributor](https://opencollective.com/osca/organization/9/avatar.svg)](https://opencollective.com/osca/organization/9/website) [![OSCA Financial Contributor](https://opencollective.com/osca/organization/10/avatar.svg)](https://opencollective.com/osca/organization/10/website) [![OSCA Financial Contributor](https://opencollective.com/osca/organization/11/avatar.svg)](https://opencollective.com/osca/organization/11/website) [![OSCA Financial Contributor](https://opencollective.com/osca/organization/12/avatar.svg)](https://opencollective.com/osca/organization/12/website) ## Contributors ✨ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): | [![](https://avatars2.githubusercontent.com/u/30334776?v=4) **Bolaji Ayodeji**](https://bolajiayodeji.com) [📖](https://github.com/oscafrica/documentation/commits?author=BolajiAyodeji) | [![](https://avatars3.githubusercontent.com/u/30195980?v=4) **Prosper Opara**](https://kodekage.tech) [📖](https://github.com/oscafrica/documentation/commits?author=kodekage) | [![](https://avatars3.githubusercontent.com/u/6048601?v=4) **Samson Goddy**](http://samsongoddy.com) [📖](https://github.com/oscafrica/documentation/commits?author=samswag) | [![](https://avatars0.githubusercontent.com/u/13289217?v=4) **Ada Nduka Oyom**](http://medium.com/kolokodess) [📖](https://github.com/oscafrica/documentation/commits?author=Kolokodess) | [![](https://avatars0.githubusercontent.com/u/32799642?v=4) **Ogheneyoma Obomate Okobiah**](https://github.com/yomaokobiah) [📖](https://github.com/oscafrica/documentation/commits?author=yomaokobiah) | [![](https://avatars1.githubusercontent.com/u/30669761?v=4) **Peace Ojemeh**](http://peaceojemeh.com/) [📖](https://github.com/oscafrica/documentation/commits?author=perriefidelis) | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! # Introduction ![](/files/-M8KC8-1jAuS1-Ybf-LG) # Terminology # Community Code of Conduct > \_“Alone we can do so little, together we can do so much” Open Source Community Africa community is made up of members from around Africa, with a diverse set of skills, personalities, and experiences. It is through these differences that our community experiences great successes and continued growth. When you're working with members of the community, this Code of Conduct will help steer your interactions and keep Open Source Community Africa a positive, successful, and growing community. ## Our Community Members of Open Source Community Africa are **open, considerate, and respectful**. Behaviours that reinforce these values contribute to a positive environment, and include: ### Being open Members of the community are open to collaboration, whether it's on PEPs, patches, problems, or otherwise. Focusing on what is best for the community. We're respectful of the processes set forth in the community, and we work within them. ### Acknowledging time and effort We're respectful of the volunteer efforts that permeate the OSCA community. We're thoughtful when addressing the efforts of others, keeping in mind that often times the labor was completed simply for the good of the community. ### Being respectful of differing viewpoints and experiences We're receptive to constructive comments and criticism, as the experiences and skill sets of other members contribute to the whole of our efforts. ### Showing empathy towards other community members We're attentive in our communications, whether in person or online, and we're tactful when approaching differing views. ### Being considerate Members of the community are considerate of their peers -- other OSCA members. ### Being respectful We're respectful of others, their positions, their skills, their commitments, and their efforts. ### Gracefully accepting constructive criticism When we disagree, we are courteous in raising our issues. ### Using welcoming and inclusive language We're accepting of all who wish to take part in our activities, fostering an environment where anyone can participate and everyone can make a difference. ## Our Standards Every member of our community has the right to have their identity respected. The OSCA community is dedicated to providing a positive experience for everyone, regardless of age, gender identity and expression, sexual orientation, disability, physical appearance, body size, ethnicity, nationality, race, or religion (or lack thereof), education, or socio-economic status. ### Inappropriate Behavior Examples of unacceptable behavior by participants include: * Harassment of any participants in any form * Deliberate intimidation, stalking or following * Logging or taking screenshots of online activity for harassment purposes * Publishing others' private information, such as a physical or electronic address, without explicit permission * Violent threats or language directed against another person * Incitement of violence or harassment towards any individual, including encouraging a person to commit suicide or to engage in self-harm * Creating additional online accounts in order to harass another person or circumvent a ban * Sexual language and imagery in online communities or in any conference venue, including talks * Insults, put downs, or jokes that are based upon stereotypes, that are exclusionary, or that hold others up for ridicule * Excessive swearing * Unwelcome sexual attention or advances * Unwelcome physical contact, including simulated physical contact (eg, textual descriptions like "hug" or "backrub") without consent or after a request to stop * Patterns of inappropriate social contact, such as requesting/assuming inappropriate levels of intimacy with others * Sustained disruption of online community discussions, in-person presentations, or other in-person events * Continued one-on-one communication after requests to cease * Other conduct that is inappropriate for a professional audience including people of many different backgrounds Community members asked to stop any inappropriate behavior are expected to comply immediately. ### Weapons Policy No weapons are allowed at OSCA events. Weapons include but are not limited to explosives (including fireworks), guns, and large knives such as those used for hunting or display, as well as any other item used for the purpose of causing injury or harm to others. Anyone seen in possession of one of these items will be asked to leave immediately, and will only be allowed to return without the weapon. ### Consequences If a participant engages in behavior that violates this code of conduct, the Open Source Community Africa Code of Conduct team may take any action they deem appropriate, including warning the offender or expulsion from the community and community events with no refund of event tickets. Thank you for helping make this a welcoming, friendly community for everyone. ## Scope ### OSCA Events This Code of Conduct applies to the following people at events hosted by Open Source Community Africa: * Board members * Core team * Team * Chapter leads * Contributors * Moderators * Speakers * Panelists * Tutorial or workshop leaders * Poster presenters * People invited to meetings or summits * Exhibitors * Organizers * Volunteers * All attendees The Code of Conduct applies in official venue event spaces, including: * Exhibit hall or vendor tabling area * Panel and presentation rooms * Hackathon or sprint rooms * Tutorial or workshop rooms * Poster session rooms * Summit or meeting rooms * Staff areas * Con Suite * Meal areas * Party suites * Walkways, hallways, elevators, and stairs that connect any of the above spaces The Code of Conduct applies to interactions with official event accounts on social media spaces and applications, including: * Comments made on official event channels on Discord * Comments made on official event social media posts * Comments made on official conference apps * Comments made on event video hosting services * Comments made on the official event hashtag or panel hashtags Event organizers will enforce this code throughout the event. Each event is required to provide a Code of Conduct Committee that receives, evaluates, and acts on incident reports. Each event is required to provide contact information for the committee to attendees. The event Code of Conduct Committee may (but is not required to) ask for advice from the Open Source Community Africa Code of Conduct team. Open Source Community Africa Code of Conduct team can be reached by emailing . ### OSCA Online Spaces This Code of Conduct applies to the following online spaces: * The [Discord Server](https://oscafrica.org/discord). * All [mailing lists hosted by OSCA](https://us17.campaign-archive.com/home/?u=2339b35e3ca4c86944e0601d0\&id=e9c39b69f6). * Code repositories, issue trackers, and pull requests made against any Open Source Community Africa controlled GitHub organization. * Any other online space administered by Open Source Community Africa. This Code of Conduct applies to the following people in the official Open Source Community Africa online spaces: * Community managers * Admins of the online space * Core team * Moderators * Chapter leads * Maintainers * Reviewers * Contributors * All community members Each online space listed above are required to provide contact information for any administrators/moderators to the Open Source Community Africa Code of Conduct team. Each online space listed above is encouraged to provide a welcome message with a link to this Code of Conduct and the contact information for making an incident report to community members. Open Source Community Africa Code of Conduct team will receive and evaluate incident reports from the online communities listed above. Open Source Community Africa Code of Conduct team will work with online community administrators/moderators to suggest actions to take in response to a report. In cases where the administrators/moderators disagree on the suggested resolution for a report, the Source Community Africa Code of Conduct team may choose to notify the Open Source Community Africa board. ### Contact Information If you believe that someone is violating the code of conduct, or have any other concerns, please contact a member of the Open Source Community Africa Code of Conduct team immediately. They can be reached by emailing or messaging *Bolaji#3828* on [Discord](https://oscafrica.org/discord). ## License [![Creative Commons License](https://camo.githubusercontent.com/005cfe27b7c4520ac0d6b607d6a7e33f5ad4eb6e/68747470733a2f2f692e6372656174697665636f6d6d6f6e732e6f72672f6c2f62792f342e302f38387833312e706e67)](http://creativecommons.org/licenses/by/4.0/) This work is licensed under a [Creative Commons Attribution 4.0 International License](http://creativecommons.org/licenses/by/4.0/). ## Attributions This Code of Conduct is based on the Code of Conduct of the [Python Software Foundation](https://www.python.org/psf/codeofconduct) which was forked from the example policy from the [Geek Feminism wiki, created by the Ada Initiative and other volunteers](http://geekfeminism.wikia.com/wiki/Conference_anti-harassment/Policy), which is under a [Creative Commons Zero license](https://creativecommons.org/publicdomain/zero/1.0/). # Branding Guidelines ## Naming guidelines 1. The official name for the organization is "Open Source Community Africa" with its acronym as OSCA. 2. When writing the the official name for the organization, the first letter of each word should be *capitalized*. 3. The official acronym for the organization should be spelt using *UPPERCASE* only. ### Do’s * Refer to the community as "OSCA". * Describe the community as "OSCA" stands for "Open Source Community Africa and is a community of Open source advocates and contributors across Africa.". ### Don’t: * Refer to the community as "Open Source Africa" or "Open Source Community" instead of the acronym "OSCA". ## Chapter naming guideline ### Do's * Each local OSCA chapter must be named as "OSCA (Location)". * Name your chapter with a “Location” that is a city (e.g. Lagos, Port Harcourt)Refer to your chapter as "OSCA (Location)" ### Don’t * Refer to your chapter as a “Open Source Community (Location),” "Open Source Africa (Location)" or "Open Source (Location)." * Name your chapter with a “Location” that is a country or continent (e.g. Ghana, South-Africa, Africa). # FAQs ## Can I become who I want to be? That's a tough question but thankfully, our team is on it. Please bear with us while we're investigating. ## Can I become who I want to be? That's a tough question but thankfully, our team is on it. Please bear with us while we're investigating. # Team ### Samson Goddy Core Contributor\ Co-founder\ Abuja, 🇳🇬. [X (Twitter)](https://twitter.com/Samson_Goddy), [LinkedIn](https://www.linkedin.com/in/samsongoddy) ### Ada Nduka Oyom Core Contributor\ Co-founder\ Lagos, 🇳🇬. [X (Twitter)](https://twitter.com/Kolokodess), [LinkedIn](https://www.linkedin.com/in/ada-nduka-oyom) ### Peace Ojemeh Core Contributor\ Founding Member & Design Lead\ Abuja, 🇳🇬. [X (Twitter)](https://twitter.com/Peace_Ojemeh), [LinkedIn](https://www.linkedin.com/in/peace-ojemeh-0b5bb2151) ### Ogheneyoma Okobiah Core Contributor\ Partnerships & Finance Lead\ Abuja, 🇳🇬. [X (Twitter)](https://twitter.com/yomdroid), [LinkedIn](https://www.linkedin.com/in/ogheneyoma-okobiah) ### Bolaji Ayodeji Core Contributor\ Community Manager & Technical Support\ Abuja, 🇳🇬. [X (Twitter)](https://twitter.com/iambolajiayo), [LinkedIn](https://www.linkedin.com/in/iambolajiayo) ### Princess Egbuna Core Contributor\ Engineering Lead\ Lagos, 🇳🇬. [X (Twitter)](https://twitter.com/PrincesOluebube), [LinkedIn](https://www.linkedin.com/in/egbunaoluebubeprincess) ### Ruth Ikegah Core Contributor\ Program Manager\ Lagos, 🇳🇬. [X (Twitter)](https://twitter.com/IkegahRuth), [LinkedIn](https://www.linkedin.com/in/ruth-ikegah/) *** ### Edidiong Asipko Community & Documentation\ Lagos, 🇳🇬. [X (Twitter)](https://twitter.com/Didicodes), [LinkedIn](https://www.linkedin.com/in/edidiong-asikpo-2b792a147) ### Josh Ike Chukwuanu Engineering\ Abuja, 🇳🇬. [X (Twitter)](https://twitter.com/IkeChukwuanu), [LinkedIn](https://www.linkedin.com/in/chukwuanu) ### Alabo Briggs Engineering\ Abuja, 🇳🇬. [X (Twitter)](https://twitter.com/alabobriggs_), [LinkedIn](https://www.linkedin.com/in/alabo-briggs-31744a161) ### Steve Anthony Design\ Port Harcourt, 🇳🇬. [X (Twitter)](https://twitter.com/steveanthny), [LinkedIn](https://www.linkedin.com/in/stephenokonkwo) # The OSCA Way # Values # OSCA Governance This policy came into effect in June 2016 and will be reviewed periodically (see revision sections). The last modification has been made in June 2016. ## Goals The goals of Open Source Community Africa Governance are to: * Create a set of minimum requirements for a sub-project hosted on oscafrica.org, * Create a lightweight project life cycle that: * leads the project to articulate its goals and how to achieve them, * encourages desired behaviors (e.g., open development), * provides motivation for the project to succeed, * leads to non-viable projects failing quickly, and * provides opportunities for other community members. * Avoid bureaucracy, i.e., the life cycle should be as informal as possible, * Encourage Open Source Community Africa-related projects to be hosted on oscafrica.org rather than going elsewhere, and * Set clear expectations to vendors, upstream and downstream projects, and community members. ## Principles ### Openness Open Source Community Africa is open to all individuals in their individual capacities, and provides the same opportunity to all. Everyone participates with the same rules. There are no rules to exclude prima facie any potential individual contributors, which include individuals associated with direct competitors in the marketplace. ### Transparency All project discussions, minutes, deliberations, project plans, designs, plans for new features, and other artifacts shall be open, public, searchable, and easily accessible to everyone. ### Meritocracy The Open Source Community Africa community is a meritocracy. The more you contribute, the more responsibility you will earn. Leadership roles in Open Source Community Africa are also merit-based and earned by peer acclaim. ### Consensus Decision Making Open Source Community Africa projects or teams are self-governing and driven by the people who volunteer for the job. When more formal decision making and coordination is required, decisions are taken with a ["lazy consensus"](http://openoffice.apache.org/docs/governance/lazyConsensus.html) approach: a few positive votes with no negative vote is enough to get going. Sometimes a member of the community will believe a specific action is the correct one for the community but are not sure enough to proceed with the work under the lazy consensus model. In these circumstances they can state Lazy Consensus is in operation. What this means is that they make a proposal and state that they will start implementing it in **72 hours** unless someone objects. 72 hours is chosen because it accounts for different timezones and non-Open Source Community Africa commitments. If the 72 hours are touching a weekend/holidays it would be wise to extend the timeframe a bit. This will ensure that people can participate in the proposal even when they were offline over the weekend. Voting is done with numbers: * +1 : a positive vote * 0 : abstain, have no opinion * -1 : a negative vote A negative vote should include an alternative proposal or a detailed explanation of the reasons for the negative vote. The project community then tries to gather consensus on an alternative proposal that resolves the issue. In the great majority of cases, the concerns leading to the negative vote can be addressed. ## Conflict Resolution ### Refereeing Open Source Community Africa projects and teams are not democracies, but meritocracies. In situations where there is disagreement on issues related to the day-to-day running of the project, Committers and Project Leads are expected to act as referees and make a decision on behalf of the Open Source Community Africa community. Referees should consider whether making a decision may be divisive and damaging for the Open Source Community Africa community. In such cases, the committers of the project can privately vote on an issue, giving the decision more weight. ### Last Resort In some rare cases, the lazy consensus approach may lead to the community being paralyzed. Thus, as a last resort when consensus cannot be achieved on a question internal to a project, the final decision will be made by a secret ballot majority vote amongst the committers and project lead. If the vote is tied, the project lead gets an extra vote to break the tie. For questions that affect several projects, committers and project leads of mature projects will hold a secret ballot majority vote. If the vote is tied, the Open Source Community Africa Steering Committee will break the tie through a casting vote. ## Roles ### Maintainers Maintainers own one or several components in Open Source Community Africa. A maintainer reviews and approves changes that affect their components. It is a maintainer's prime responsibility to review, comment on, co-ordinate and accept patches from community members, and to maintain the design cohesion of their components. A project's maintainers shall be listed in a MAINTAINERS file in the root of that project's code repository or documentation page. ### Committers Committers are Maintainers who are allowed to commit changes into a repository. The committer acts on the wishes of the maintainers and applies changes that have been approved by the respective maintainer(s) to the repository. Due to their status in the community, committers can also act as referees, should disagreements amongst maintainers arise. Committers are listed on the project's team web page. ### Projects and Teams Open Source Community Africa organizes itself into a number of projects, which follow the Project Governance (or Project Lifecycle) as outlined in this document. Projects are run by individuals and are often referred to as teams to highlight the collaborative nature of development. For example, each project has a team page on oscafrica.org. ### Project Lead Open Source Community Africa projects and teams are managed by a Project Lead, who is also a committer of the project/team they lead. Project Lead is the public figurehead of the project and is responsible for the health of the project. Due to their status in the community, project leads can also act as referees should disagreements amongst committers of the project arise. The project lead typically also has write access to resources, such as the web page of a specific project. ### Open Source Community Africa Steering Committee The Open Source Community Africa Steering Committee consists of members who are committed to steering Open Source Community Africa to advance its market and technical success, and who serve as positive ambassadors for the project. The Open Source Community Africa Steering Committee manages non-technical aspects of Open Source Community Africa including funding for shared project infrastructure, marketing and events, and managing Open Source Community Africa trademarks. The Steering Committee leaves all technical decisions to the open source meritocracy. ### Mentor Younger projects may have a need for a mentor to help ensure that the project will be successful. Mentors can be maintainers, project leads, Steering Committee members or other distinguished community members. Mentors are expected to have a monthly review and report back to the community about movement from incubation to maturity. ### Sponsor To form a new Open Source Community Africa project or team, we require a sponsor to support the creation of the new project. A sponsor can be a project lead or committer of a mature project, a member of the Steering Committee or the community manager. This ensures that a distinguished community member supports the idea behind the project and is responsible to find an appropriate mentor for the project. ## Making Contributions Making contributions in Open Source Community Africa follows the conventions as they are known in the Linux Kernel community. In summary, contributions are made through pull requests that are reviewed by the community. Open Source Community Africa does not require community members to sign contribution or committer agreements. More information on making contributions can be found in the following documents: * [Contribution Guidelines for Open Source Community Africa Toolkit](https://gitlab.com/Open%20Source%20Community%20Africa/lh-toolkit/blob/master/CONTRIBUTING.md) * Contribution Guidelines (others upcoming) ## Elections and Formal Votes ### Maintainer Elections Developers who have earned the trust of maintainers (including the project lead) can be promoted to Maintainer. A two-stage mechanism is used: * **Nomination:** A maintainer should nominate himself by proposing a patch to the MAINTAINERS file or mailing a nomination to the project's mailing list. Alternatively another maintainer may nominate a community member. A nomination should explain the contributions of proposed maintainer to the project as well as a scope (set of owned components). Where the case is not obvious, evidence such as specific patches and other evidence supporting the nomination should be cited. * **Confirmation:** Normally, there is no need for a direct election to confirm a new maintainer. Discussion should happen on the mailing list using the principles of consensus decision making. If there is disagreement or doubt, the project lead or a committer should ask the community manager to arrange a more formal vote. ### Committer Elections Developers who have earned the trust of committers in their project can through election be promoted to Committer. A two-stage mechanism is used: * **Nomination:** Community members should nominate candidates by posting a proposal by sending a direct message to the "Appointments" group on Open Source Community Africa Forums, explaining the candidate's contributions to the project and thus why they should be elected to become a Committer of the project. The nomination should cite evidence such as patches and other contributions where the case is not obvious. Existing Committers will review all proposals, check whether the nominee would be willing to accept the nomination and publish suitable nominations in the Open Source Community Africa Forums publicly for wider community input. * **Election:** A committer will be elected using the decision making process outlined earlier. Voting will be done by committers for that project privately using a voting form that is created by the community manager. Should there be a negative vote the project lead and community manager will try and resolve the situation and reach consensus. Results will be published in the public forums. ### Project Lead Elections Projects which lose their project lead are at risk of failing. Should this occur, the project's maintainer community should agree on a suitable new project lead and follow the election process as outlined above. ### Formal Votes Sometimes it is necessary to conduct formal voting within the Open Source Community Africa community (outside of elections). Formal votes are necessary when processes and procedures are introduced or changed, or as part of the Project Governance. Who is eligible to vote, depends on whether the scope of a process or procedure is **local** to a project or team, or whether it affects all projects (**global**). An examples of local scope is a code review policy which applies to the EMR project only. Examples of global scope are changes to this document or votes outlined in the Open Source Community Africa Community Governance document. * **Scope:** Local * **Who reviews:** Members of developer mailing lists of the affected projects. * **Who votes:** Maintainers of the project (or projects), which are affected by the process, procedure, etc. are allowed to vote. This includes maintainers from incubation projects (if the scope affects the project). * **Scope:** Global * **Who reviews:** Readers of all Open Source Community Africa Forums project categories. * **Who votes:** Maintainers of all **mature projects** and the Open Source Community Africa community manager are allowed to vote. The community manager first arranges a public review, followed by a timed private vote. Public review and voting should be open for a minimum of a week each. For voting a traceable poll mechanism, e.g., a voting system that keeps auditable and tamper proof records, must be used. Voting follows the conventions as laid out in "Principle: Consensus Decision Making". ## Project Governance ### Basic Project Life Cycle The proposal is to follow a simple basic flow: ![alt tag](http://i.imgur.com/f1mgSxN.png) A Open Source Community Africa project starts with an idea which through the process of project formation will grow into a project proposal. The project proposal will need to satisfy some basic conditions, will be put out for community review and is then put to a vote to all maintainers and project leads of mature Open Source Community Africa projects following the usual decision making process. For agreed project proposals, Open Source Community Africa will provide basic infrastructure and the project can get started. Projects in incubation are working towards a set of goals, will get additional support and marketing opportunities from the Open Source Community Africa. However, there will also be regular checkpoints to see whether the project is progressing. Should it turn out that a project is not viable any more, it will be archived after an archival review and vote. For a project to graduate, some basic conditions must be satisfied. If a project in incubation has achieved the point where it believes it is mature enough to graduate, it can request a Graduation community review followed by a vote. Mature projects are expected to run themselves. However, at some point a mature project will lose momentum and developers. If this is the case the Open Source Community Africa community can request an archival review, which follows the usual pattern. Archival reviews have two purposes: * To give somebody in the community an opportunity to step up and continue a project, and * To archive the project outcomes such that they are still available to people who want to use them, but promotion of such projects will cease. It is also possible to revive archived projects. However these are treated almost like new projects as projects would only be archived if they have become inactive. ### Requesting Reviews, Reviews and Voting **Requesting Reviews:** Project Proposal and Graduation Reviews are requested by the (prospective) project lead of the project by contacting the community manager providing the necessary documentation. An archival review can be requested by any maintainer of a mature project or by the Open Source Community Africa community manager. The community manager will then publish relevant material on the respective forums. **Reviews:** These are off-line reviews which are open to all community members by which a proposal is published for review. The purpose of the review is two-fold: * To gather final feedback and input from the community (it is good practice to informally do this before the review), and * To advertise the project with the aim to attract interest, users and contributors. After a review, the requester of the review may decide to withdraw, request a re-review or progress to a vote by arranging with the community manager. **Voting:** The community manager arranges a timed private vote as outlined in Formal Votes. ### Forming a Project Requirements for forming a Open Source Community Africa project (or team): * A project needs a lead, who is willing to become the project lead of the sub-project. * A project needs a sponsor, which can be a project lead of a mature project, a member of the Open Source Community Africa Steering Committee, or the community manager. * There should be no dissent from other community members who would qualify as sponsor (see "Principle: Consensus Decision Making"). * A project needs a mentor, which can be the project sponsor or a maintainer of a mature project. * A project needs to have a relationship to other projects or teams, i.e., it aims to develop software that has a dependency on other Open Source Community Africa projects or teams. If the project needs components in other projects to work, then this should also be stated. * A project needs to be large and long-term enough to grant a separate project. For example adding support for a new clinical domain, adding additional functionality on top of existing projects, etc. Adding a new feature to an existing project should be performed within an existing project. * A project will deliver code using a license that is compatible with other Open Source Community Africa projects, ideally MPL 2.0 HD. The purpose of the project formation phase is to work out what the project is about, get community buy-in and help the future project gain publicity and momentum. The formation phase is driven by that project's project lead. The project mentor's role is to advise and support the project lead in getting the project started. The project proposal is a document that is published on forums.oscafrica.org and describes: * What the project is aiming to achieve, i.e., the project charter and project goals, * What components/code and in which code lines (new or components in other projects) the project aims to deliver, * Key dependencies on other Open Source Community Africa projects or teams, if applicable, * A list of initial maintainers, if applicable, * A lists of any interested parties in the project, if applicable, * A lists of any planned initial code contributions, if applicable, and * A rough plan on how to get through the Incubation phase. ### Project Proposal Review The review is initiated by the project lead and follows the rules outlined in "Requesting Reviews, Reviews and Voting". After a successful review, the following resources will be created for the project: * A category in the Open Source Community Africa forums, * A code repository, and * A project or team page on oscafrica.org, in an area separate from mature projects, to be maintained by the project lead. ### Incubating a Project The purpose of the incubation phase is for a project to show that it is gathering momentum and adheres to the "Principles & Roles" of Open Source Community Africa projects. The project mentor will work closely with the project lead and there are at least quarterly informal review meetings with the mentor on how the project is doing. Should a mentor not be able to fulfill his/her role any more, it is the responsibility of the project lead to find another mentor. We advise that the project lead gives at least quarterly updates on the Open Source Community Africa blog on how the project is doing. Open Source Community Africa will provide support to incubating projects. The project lead will work closely with the Open Source Community Africa community manager as well as with the project mentor. ### Archiving an Incubating project The mentor can request for a project to be archived, if the project is not making sufficient progress. See "Archival Review". ### Graduation Review The review is initiated by the project lead and follows the rules outlined in "Requesting Reviews, Reviews and Voting". In essence, the project lead makes a pitch to the community about why the project should graduate. A project must fulfill the following requirements before it can graduate: 1. It follows the principles of openness, transparency and meritocracy. 2. It has delivered at least one functioning release of what it is aiming to deliver. 3. It has a public code repository which shows active development, has mechanisms to accept patches, and a history of accepting patches. 4. It has a public forum that is active. 5. It has a mechanism for users to raise bugs and for developers to work on bugs. 6. It has an active developer community, including multiple maintainers, a diverse profile of individuals, etc. Other items to look at during the review (depending on project are): 1. It has up-to-date documentation and a core and group of people maintaining it. 2. It publishes regular builds and tests. 3. It promotes itself at Open Source Community Africa events and on the Open Source Community Africa blog. ### Mature Projects Mature projects are expected to be run and promote themselves. The project lead has significant responsibility in ensuring that this happens. The Open Source Community Africa Steering Committee and the community manager will help organize events, provide opportunities for the project to get new contributors and build a community, promote new releases on the blog and to the press, work with project members, etc. However the Open Source Community Africa Steering Committee and the community manager will not get involved in the day-to-day running of the project. At some point during its lifecycle, a project may lose momentum. In other words, developers and users are not interested in the project any more. If this is the case, it may be time to archive the project. If the project has achieved its goals and is thus completed, it may also be time to archive the project. ### Archival Review These can happen in a number of situations: * An incubation project shows clear signs of failing and not progressing. * A mature project has lost its developer and user base, and there is little or no activity. * The project has achieved its goals and/or fulfilled its charter. In other words, it has completed. In the first case, the review is triggered by the incubation project's mentor. Failing this, the review can be requested by any maintainer of any mature project (including the project's lead) or by the Open Source Community Africa community manager. See "Requesting Reviews, Reviews and Voting". The review is essentially a pitch why the project should be archived. The purpose of the review is not necessarily to archive a project, but also to provide a last opportunity for interested parties in the Open Source Community Africa community to save the project and step up. The Open Source Community Africa community manager will support efforts to save the project, should community members want to step up. In the case where a project has been completed, the normal situation would be for the project lead to make the case for archival. ### Archived Projects When a project is archived, the following happens: 1. The code repository and forums will be made read-only and made accessible from an "archived projects" section of oscafrica.org. 2. The project's documentation pages will be tagged as "archived". A project may be completed, i.e., it has achieved its goals and/or fulfilled its charter, in which case it is tagged as "completed" and "archived". 3. The project or team page on oscafrica.org will be moved into an "Archive" or "Completed" section. In cases where the project has delivered code into other Open Source Community Africa projects, the code will be: * Deprecated at the point where the project is archived, and * The project which now contains the archived code can (but does not have to) remove the code in a subsequent release (it should however give users sufficient time to adapt) ## Exceptional Circumstances ### Projects without Project Lead Projects which lose their project lead during the incubation or maturity phase are at risk of failing. Should this occur, the project's maintainer community should agree who would want to be/be able to be the new project lead and follow the election process as outlined in "Electing Maintainers". If a project lead leaves during the formation phase without finding a successor, we assume that the project does not have enough momentum and will not go ahead. ### Incubation projects without Mentor Should an incubation project lose its mentor, the Open Source Community Africa community manager will support the project lead in finding a new mentor. ## Acknowledgements *This work, "Open Source Community Africa Community Governance", is a derivative of "Xen Project Governance" by Xen Project, used under the Creative Commons Attribution 3.0 License (CC BY 3.0). "Open Source Community Africa Community Governance" is licensed under the Creative Commons 4.0 International Attribution License (CC BY 4.0) by Humanitech Inc.* ## Change History * **ver. 0.1** Initial Draft, 15 June 2016 # Core Contributors Guidelines # Core Contributors: Communication # Chapters An Open Source Community Africa chapter is a community closer to home. It typically consists of a group of people coming together to organize and facilitate meetups, creating an environment of support in possible areas of challenge while following the OSCA Code of Conduct. Our goal is to increase the rate of credible contributions by African software developers, designers, writers, and everyone involved in the sphere of technology to open source projects both locally and globally, changing Africans' perception from just the billion users to the NEXT BILLION CREATORS. An OSCA chapter lead represents a global network of open-source enthusiasts and is responsible for growing and supporting vibrant local OSCA communities in Africa. {% embed url="" %} Learn more about the OSCA community. {% endembed %} # Chapter Leads Application Kindly apply to start an OSCA chapter in your city with the link below 👇🏾 {% embed url="" %} # Chapter Leads OnBoarding Guide Introductory guide to the OSCA Chapters Program for new chapter leads. [Open Source Community Africa](https://oscafrica.org/community) (OSCA) is an inclusive community created in 2018 for open-source lovers, enthusiasts, advocates, and experts within Africa. As a community, we intend to help integrate the act of open-source contribution to African developers whilst strongly advocating the movement of free and open-source software. Our goal is to increase the rate of credible contributions by African software developers, designers, writers, and everyone involved in the sphere of technology to open-source projects both locally and globally, changing Africans' perception from just the billion users to the **NEXT BILLION CREATORS**. As an OSCA Chapter Lead, you represent a global network of open-source enthusiasts, and you are responsible for growing and supporting a vibrant local OSCA community in Africa. ![](/files/sLZZu5FAmfLFt52aMsmp) ### Chapter Lead Responsibilities As an OSCA chapter lead in the program, we expect you to: * Abide by our [community code of conduct](https://docs.oscafrica.org/about/community-code-of-conduct). * Lead an engaged communication channel for your chapter. * Host events (offline or online) that align with OSCA’s goal. * Teach and support your community members to contribute to and build open-source projects that solve social problems or any problem around them. * Measure and report all activities you organize and engage in. * Promote Open Source Community Africa in your chapter. * Share updates, feedback, event details, and more as may be requested by the Community Managers to keep them abreast of the amazing work you are doing in your chapter. ### Recommended Practices Successful leads ensure that the local community they lead embodies OSCA’s core mission and goals. We strongly recommend doing the following as a Chapter Lead:
1️⃣ Promote Open Source and Open Source Community Africa in your City * Evangelize OSCA programs and activities within your local tech community. * Share updates about your chapter through your different social media channels (Discord, LinkedIn, Twitter, Facebook, WhatsApp, etc.) * Act as a mentor to your community members, connecting them to opportunities, and identifying partnerships.
2️⃣ Lead an Engaged Communication Channel for Your Chapter * Keep track of all your community members' counts and demographics. * Promote ongoing discussions and knowledge sharing. * Post content and helpful resources about open-source frequently. * Understand your community members’ interests and create activities around them.
3️⃣ Host Events and Activities * Teach and support your community members to contribute to and build open-source projects that solve social problems or any problem around them. * Plan a physical or virtual event as outlined in the community calendar to avoid being blacklisted. * Invite local or global speakers with experience in the covered topics. * Communicate and partner with local communities, tech hubs, and organizations. * Host any activity (meetup, webinar, workshop, hackathon, project, etc.) that supports your community's open-source education needs.
4️⃣ Coordinate with OSCA’s Community Managers * Participate in the monthly community calls with your community manager. * If you need to take any action and you're unsure if it's acceptable, please ensure to run the idea through your community manager for approval before proceeding. * Coordinate with the Open Source Community Africa for support in planning your event (scope, promotion, etc.). * Submit event reports after every meetup/event you organize for your local community.
### Chapter Leads Hub As an OSCA Chapter Lead, you will use the private [Chapter Leads Hub](https://github.com/oscafrica/chapter-leads-hub) GitHub repository for: * Discussing and planning chapter activities. * Requesting help, support, or materials from Open Source Community Africa. * Tracking and talking about the activities you are organizing. * Exploring the design assets, expenses guide, and sponsorship guide. * Anything else a Chapter Lead needs to be successful. Kindly read all the guides (design, sponsorship, expenses, and budget) and other resources, as outlined in the README. ### Approved Services You can create an account for your chapter on the following approved services using your official Gmail address and naming convention as instructed below. * Gmail * X (Twitter) * WhatsApp groups * Telegram groups * GitHub individual account or organization * GitLab individual account or organization {% hint style="info" %} Please note that you're not allowed to create an account for your chapter on any platform or service other than the ones mentioned in this guide. If you need anything else or when in doubt, kindly reach out to your community managers for help before doing anything. {% endhint %} ### Social Media As an OSCA lead, you represent us and our values, and we implore you **not** to use any hate speech on social media. Instead, find below guides to follow while interacting with members of your community: 1. Create a [Gmail address](https://accounts.google.com/SignUp) for your chapter (e.g., ). You will use this email to sign up for other approved services and to send emails to members of your community/event attendees. 2. Create an [X (Twitter) account](https://twitter.com/i/flow/signup) for your chapter and customize the account. 3. Ensure that the account name always starts with OSCA followed by the chapter name (e.g., OSCA Nairobi), and the handle should be OSCA (in lowercase) followed by the chapter name (e.g., @oscanairobi or @osca\_nairobi). 4. Upon creating a social account for your chapter, kindly copy, edit, and use this for your chapter’s bio: *"A budding @osca\_hq community of open-source advocates and contributors in \[Chapter’s city, State, Country Flag]."* 5. Always tag @osca\_hq when creating awareness about your events or initiatives. 6. Use the hashtags like **#OSCAUyo**. That is, #OSCA\[City of your chapter]. 7. When giving out information, ensure that it is from a reliable source. 8. Do not post negative information about OSCA or its affiliates or partners. *** Thank you for coming this far. We wish you all the best as you begin this new journey. Cheers! 🧡 # Chapters Design Guide {% file src="/files/WWG6g0mrGGdRnsiz8Ezb" %} # OSS Jobs # Roadmap # Sponsorship Tiers # Expense Policy # Expenses & Getting Paid # Submitting Expenses # Approving Expenses # Editing Expenses # Core Contributors Expense Guidelines # OSCA Open Source Challenge # Hacktoberfest Hacktoberfest is a month-long celebration of open source software run by DigitalOcean in partnership with GitHub and Twilio. When you submit five quality pull requests to public GitHub repositories, you get a chance to earn a limited-edition T-shirt. Learn more 👇🏿 {% embed url="" %} # Google Summer of Code Google Summer of Code is a global program focused on bringing more student developers into open source software development. Students work with an open-source organization on a 3-month programming project during their break from school. Learn more 👇🏿 {% embed url="" %} # Google Season of Docs The goal of Season of Docs is to provide a framework for technical writers and open source projects to work together towards the common goal of improving an open-source project's documentation. Learn more 👇🏿 {% embed url="" %} # Outreachy Outreachy provides remote internships that support diversity in open source and free software. Outreachy internships are 3 months long and interns are paid an internship stipend of $5,500 USD with a $500 USD travel stipend to attend conferences or events. Learn more 👇🏿 {% embed url="" %} # Engineering Everything Engineering related in OSCA ### Join our conversation You can join the discussions in the OSCA `#engineering` channel on [Discord](https://bit.ly/discord), under the OSS groups category. You can talk to us about any of the engineering-related issues. # Contribution Guidelines ## How to Contribute: We use the pull-request model, see [GitHub's help on pull-request](https://help.github.com/articles/using-pull-requests). In quick summary, you will: * on GitHub, find and fork the source repository; * on your computer, clone your forked repository, * commit your changes in a new branch; * push your branch and submit a pull-request for it; * go through the review process until your pull-request is merged; and #### Picking up issues * You should only pick up one issue at a time and must **assign yourself** to it. Any unassigned issue is up for grabs. * If you can no longer work on an issue, please un-assign yourself. * If someone is already assigned to an issue, do not un-assign them or submit a pull request with work related to that issue. * If you notice the person assigned to the issue hasn't made any updates in more than one week, you can @ them in a comment to check in. *Please note there is no need to ask permission to work on an issue. You should check for pull requests linked to an issue you are addressing; if there are none, then assume nobody has done anything.* *Begin to fix the problem, test, make your commits, push your commits, then make a pull request. Mention an issue number in the pull request, but not the commit message. These practices allow for sanity and orderliness for revieweres* ## Projects: All of our active repositories can be found on our [GitHub O.S.C.A\`organization](https://github.com/oscommunityafrica). #### Checklist - anyone * [ ] make a fork and clone it, * [ ] confirm if what you want to change is already present in any other branches or forks, * [ ] make and test your changes, * [ ] if your changes add a new feature or will affect users; update the README.md file * [ ] make a branch, push your commits, and a pull request, see [Workflow](##workflow) below. #### Checklist - maintainer * [ ] look for commits *after* any of these, in either; * [ ] master branch of repository at O.S.C.A, * [ ] any other branches, * [ ] any other forks, * [ ] review and merge all pull requests, * [ ] apply all desired commits, make pull requests if review is needed, * [ ] update the README.md file if necessary, ### Workflow #### Open an Issue We track issues in the GitHub Issues tab of repositories. An improvement to any of the projects may start with an issue discussion, to build consensus and ensure that work isn't wasted. An issue may be avoided for fixing bugs that are obvious to everyone or part of a project. #### Forking You should first fork a repository on GitHub. This step is needed only once. See [complete help in GitHub](https://help.github.com/articles/fork-a-repo). #### Cloning You should clone your fork. This step is needed only once. Using [sugar](https://github.com/oscommunityafrica/docs) as example; ``` git clone git@github.com:YOUR-NAME/sugar.git cd docs git remote add upstream https://github.com/oscommunityafrica.git git fetch upstream ``` #### Branching Create a branch per set of changes; e.g. to fix a problem or add a feature; ``` git checkout -b BRANCH-NAME ``` Your BRANCH-NAME can be anything, other than master. The scope is your forked repository. The branch name will be shown on pull-requests. #### Making commits Change files, and commit. Commit messages are kept by git, and are used later when problems are being solved. When writing a commit message; 1. start with a one line summary of the change; 2. leave a blank line after the summary; 3. explain the problem that is solved, unless the summary makes it obvious; 4. when the problem was introduced by a previous commit, mention the hash; 5. when the problem is in an issue or ticket, add "Fixes #34"; 6. avoid mentioning GitHub or other pull-requests, as these are not kept in git; 7. avoid mentioning any tasks or irrelevant words ; use pull-request comments instead; and 8. make use of british english in spellings imperative mood Make one or more commits and push the branch to your repository; ``` git push origin BRANCH-NAME ``` #### Sending a pull-request Send a pull-request for your branch. Navigate to your repository page in GitHub, switch to the branch you made, and then press the **Pull Request** button. When writing a pull-request message; 1. if there is only one commit, begin with the GitHub default of the commit message, otherwise write a summary of the series of commits; 2. link to any relevant pull-requests, issues, or tickets; and A review will happen in the pull-request, and a reviewer will either; 1. merge, squash, or rebase your commits; 2. merge your commits with their own changes; 3. ask you to make changes; or 4. close and reject your pull-request giving reasons. When they ask you for changes, you may have to change both files, commits or commit messages. When squashing commits to different files, use interactive rebase. ``` git rebase -i master ``` After resolving any conflicts, push the changes to the same branch; ``` git push --force origin ``` Then respond on the pull-request. #### Keep your pull-request up to date When there has been upstream commits while your pull-request was open, you should rebase your pull-request; ``` git pull --rebase upstream ``` Then push the changes to the same branch; ``` git push --force origin ``` The pull-request will be updated. #### Keep your fork up to date When there has been upstream commits since your fork was made, you should bring these into your fork: ``` git checkout master git pull upstream git checkout BRANCH-NAME ``` #### Review We encourage testing before merging a pull-request. So instead of merging directly with the "merge" button on GitHub, we may do a local merge, then test, then push. See [GitHub help on merging a pull-request](https://help.github.com/articles/merging-a-pull-request). The GitHub page for the pull-request will provide you the right commands to do the local merge, similar to the following. Get the changes from that branch to a new local branch: ``` git checkout -b SOME-USER-topic1 master git pull https://github.com/SOME-USER/doc.git topic1 ``` Test! If everything is fine, merge: ``` git checkout master git rebase SOME-USER-topic1 git push origin master ``` #### Close Issue Once your pull-request is merged, you should close any issue or ticket. GitHub issues named as "Fixes" in a commit message may be automatically closed. Be sure to thank everyone who helped you out along the way. ## Guide for Reviewers #### Goals The Goal(s) for every review is to; * detect trivial mistakes, * maintain consistent and good code quality, * reproduce test results, (especially for critical repositories), * maintain a useful git commit history for use by git bisect, and developers who read it, * maintain other records, such as issues, tickets, and documentation, * not waste the time of the contributor, by doing anything trivial that otherwise the contributor might have to do. #### Checklist * [ ] does the change have consensus of the community, see also our [code of conduct](https://github.com/oscafrica/documentation/tree/167834663f1062d3849467800467c77384e697de/src/src/OSCA%20Code%20of%20Conduct.md) (if a reviewer is in doubt, seek opinions by @mentioning people), * [ ] does the commit message explain the summary, problem, and solution, so that it can be used in future analysis, see also [making commits](#making-commits) (if a reviewer can fix it by squash or manual rebase, do so), * [ ] does the commit message reference any issue (if a reviewer can fix it by squash or manual rebase, do so), * [ ] are the number of commits excessive for future analysis, (a reviewer may squash or rebase if necessary), * [ ] is the changed code consistent in style with the existing code ### Frequently Asked Questions #### I've used the GitHub editor, how can I rebase or amend commits? Make a local clone of your GitHub repository, use `git commit --amend` or the other advanced CLI features, then `git push` back to GitHub. #### Error 403 on `git push` You have Most likely cloned someone else's repository, and you should instead fork their repository, clone your own repository, make your changes, then push. # Conventions Conventions include generic patterns that ensure that written code adheres to certain formatting conventions. ### Code * Tabs or two-space indentation * Use shorthand for conditional statements * Always open braces on the same line as the previous statement and close braces on the same indent as the original function like so: ```javascript function textComponent() { return { name: "OSCA" }; } ``` ### Naming * Constructor functions should use the TitleCase * Variables, directories and methods should use the camelCase * Variables or elements with multiple words should always use an underscore between words. ```javascript const user_params = null; ``` * Private methods should start with a leading underscore to separate them from public methods ```javascript const _inputType = inputType; ``` * Abbreviations should be avoided please to avoid confusion * Comments should include enough information about what a part of code is supposed to do. ```javascript // Define default props of the TextBox component TextBox.defaultProps = { className: "", disabled: false, inputType: "text" }; ``` ### Styling This project uses the [BEM](https://en.bem.info/) Methodology with a camelCase style. Read the start guide [here](https://en.bem.info/methodology/quick-start/) > BEM (Block, Element, Modifier) is a component-based approach to web development. The idea behind it is to divide the user interface into independent blocks Naming Rules: ```css blockName__elementName_modifierName_modifierValue ``` * Names are written in lowercase Latin letters. * Each word inside a name begins with an uppercase letter. * The block name defines the namespace for its elements and modifiers. * The element name is separated from the block name by a double underscore (\_\_). * The modifier name is separated from the block or element name by a single underscore (\_). * The modifier value is separated from the modifier name by a single underscore (\_). * For boolean modifiers, the value is not included in the name. # Design Everything Design related in OSCA ### Join our conversation You can join the discussions in the OSCA `#design` channel on [Discord](https://bit.ly/discord), under the OSS groups category. You can talk to us about any of the design-related issues. # Contribution Guidelines Hey there 👋🏽 Welcome to OSCA design! We always need and welcome more contributors. ## Join our conversation You can join the discussions in the OSCA `#design` channel on [Discord](https://discord.gg/8STPZzN), under the OSS groups category. * **Visual designs** - Event and Social media flyers, Patterns, illustrations, wallpapers, swags ideas(stickers, t-shirts etc). * **UI and UX** - mostly web centric for now - official websites and sub domains. * **Design documention** - if you'd love to write about Open Source Design, suggest changes our existing documentions like the design style guides etc. ## Unsure of how to get involved to OSCA as a **designer**? You can join the discussions in the O.S.C.A **design** channel on [Discord](https://discord.gg/8STPZzN), under the OSS groups category. Feel free to introduce yourselve, we're all joyful people :). You can also talk to us about any of the design-related issues. ## Catch up? If you want to contribute, it is good to first familiarise yourself with our existing design work. * [Website style guide](https://www.figma.com/file/dDQ0f43gracsqn1LJYk91E/New-OSCA-website?node-id=608%3A0) * [Go through OSCA's brand assests](https://github.com/oscafrica/Design/tree/master/Brand%20Assets) * [See Festival assests and designs](https://github.com/oscafrica/Design/tree/master/OSCAFEST'20%20Assets) NB: Primary the fonts we use are: * [Ubuntu](https://fonts.google.com/specimen/Ubuntu?query=ubun) designed by Dalton Maag * [Gotham](https://www.downloadfonts.io/gotham-font-family-free/) design by Tobias Frere-Jones ## Issues? You can start by looking through the `good first issues` label. Also, you might want to contribute to a particular aspect of design that you’re most proficient in … don’t worry we’ve got you! Each design task is given a label of the type of design work required to complete that issue `UI/UX`, `graphics`, `design-documentation`. **Yes! 💪🏽 seen what you’d love to help with?** Just start, you don’t need approval from anyone. Once you have something ready for review, drop a comment and someone will attend to you ☺️. We can’t wait to receive your contributions! :) Feel free to talk to us about any of the design-related issues. # Style Guide # Documentation Everything Documentation related in OSCA ### Join our conversation You can join the discussions in the OSCA `#documentation` channel on [Discord](https://bit.ly/discord), under the OSS groups category. You can talk to us about any of the documentation-related issues. # Contribution Guidelines Contribute to OSCA Documentation This document will guide you through contributing to our documentation from start to finish. ### Prerequisites * A GitHub account. You can [create one here](https://github.com/join). * Basic understanding of the Git workflow. * Read our [style guide](/contributing/design/style-guide) to see our writing style and expectations. * Basic understanding of [how markdown works](https://www.markdownguide.org/). ### Using Git and GitHub ### Using Gitbook and GitHub ### Editing existing docs pages ### Linking pages or sections of a page together ### Adding new sections, pages and subpages # Style Guide # Issue Labels ### Engineering *Coming soon* ### Design | Label name | Description | | -------------------- | ----------------------------------------------- | | design-approved | Design ready for development | | design-in-progress | On going design task | | design-ready | Design is ready for review | | design - Stalled | Something isn't working | | design-issue | Issues related to design | | design-documentation | Improvements or additions to the documentation | | duplicate | This issue or pull request already exists | | enhancement | New feature or request | | good first issue | Good for newcomers | | Graphics | Graphics related issues | | help wanted | Extra attention is needed | | Ideation | Design ideas we're thinking about but not doing | | invalid | This doesn't seem right | | question | Further information is requested | | social media & PR | Design issues related to social media & PR | | UI/UX | Issues related to web design | | Website | Issues related to website | | wontfix | This will not be worked on | ### Documentation *Coming soon* # Awesome Open Source # OSCA Community Website # OSF Website # OSCA Chapters Directory # OSCA Documentation # OSCA Design # Individuals # Organizations