💕 First off all, thank you for your interest in the project and for taking the time to contribute!
This project is built by amazing volunteers, just like you, from different timezones, backgrounds and skills levels. So to make sure we're all on the same page, it would be great if we all followed a few guidelines. 💕
Feedback | How Can I Contribute? | Best practices | About Code for Senegal | Financial contributions | Code of conduct
Just have a quick question? Please e-mail us at at [email protected]
🐛 Think you found a bug? Please check the list of open issues to see if your bug has already been reported. If it hasn't please submit a new issue.
🛡️ If you find a security vulnerability, do not open an issue. Please email [email protected] instead.
Please be as specific as possible when describing the issue. Explain the problem and include additional details to help maintainers reproduce the problem:
- Description
- Steps to Reproduce
- Expected behavior
- Actual behavior
- Reproduces how often
💡 Feature requests are welcome. We would love to hear your thoughts on how we can improve our project further.
To send us a suggestion, just open an issue which describes the feature you would like to see. Give as much information as you can about what you would like to see:
- Description
- Step by step behaviour
- Explain why this enhancement would be useful
💻 We'd love for you to get your hands dirty and code for the project.
If you are unsure where to begin contributing to the project, you can start by looking through the issues labeled as:
Please make sure to check out the suggested coding best practices and tips with working with git below 😉
- The language we code in is English. Please name your variables, methods, classes and other structures using English words.
- Use clean code conventions ✔️ tip: read The book if you haven't already. Or check out a summary
- Follow the suggested styleguide for the programming language used in the project. Some examples:
- Tests are appreciated 😌
- Please use relevant commit messages and reference issues in the commit message if applicable
- Use the appropriate keywords when opening a PR that closes an issue (to make sure you've used it right, go to the mentioned issue and just check to see if the proper link to the PR appeared)
Our collaboration model is described here.
We are community of volunteers (developers, ux/ui, communications, data scientists, graphic designers, devops, it security and more) who work pro-bono for developing digital solutions to solve social problems. #techforsocialgood. If you want to learn more details about our projects visit our site or if you want to talk to one of our staff members, please e-mail us at [email protected].
This project and everyone participating in it is governed by the Code for Senegal Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].