Skip to content

Latest commit

 

History

History
72 lines (42 loc) · 4.23 KB

CONTRIBUTING.MD

File metadata and controls

72 lines (42 loc) · 4.23 KB

Code for Romania standard project Contributing guide

💕 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 Code4Ro | Financial contributions | Code of conduct

Feedback

Just have a quick question? Please e-mail us at at [email protected]

How can I contribute

Report bugs

🐛 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

Suggest new features

💡 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 submit a new 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

Contribute to the codebase

💻 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 asking in the Slack channel (preferred), or see the Kanban board: https://github.com/orgs/code4romania/projects/13 Especially issues with the "Good first issue" or "Help wanted" labels are good to take.

Please make sure to check out the suggested coding best practices and tips with working with git below 😉

Best practices

Coding best practices 👌

  • 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 C# coding conventions
  • Tests are appreciated 😌
  • Please use relevant commit messages and reference issues in the commit message if applicable

Git workflow

Our collaboration model is described here.

About Code4Ro

Started in 2016, Code for Romania is a civic tech NGO, official member of the Code for All network. We have a community of over 500 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].

Financial contributions

Last, but not least, we rely on donations to ensure the infrastructure, logistics and management of our community that is widely spread across 11 timezones, coding for social change to make Romania and the world a better place. If you want to support us, you can do it here.

Code of conduct

This project and everyone participating in it is governed by the Code for Romania Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].