First of all, thank you for considering to contribute to this initiative!
The Balconnect project has grown from initial efforts by Adel Sarvary to highlight the ecological importance of outdoor ornamental plants raised in metropolitan areas, and to change the current market demand under the motto 'plants are more than decorations'.
This is currently a completely independent initiative.
Please check out our roadmap and our community's code of conduct to help you get started, and the home page for an overview of the project (if you have not read it yet)!
Below you can find the main guidelines for contributing to the Balconnect project. This repository is available under CC BY 4.0 license, so you are welcome to use, reuse, remix, share and build upon the existing materials. We appreciate all your suggestions and contributions.
Any person - regardless of having or not having plants, living in metropolitan areas or not, or having access to any outdoor spaces to grow plants at or not - can participate in this project.
There are different ways in which you can contribute and hence different degrees of involvement:
The project and the first prototypes are being developed in Barcelona, Spain, therefore we would like to make all documents available in both Spanish and English. Of course, Catalan is more than welcome, too!
We are looking for anyone to help us with translation of the following documents:
- README
- Roadmap
- Code of Conduct
- Contributors' Guidelines (the document you are currently reading)
All Spanish version files will be placed in this directory: https://github.com/adelsarvary/Balconnect/tree/main/SPANISH
To submit feedback about any aspect of the project, please get in touch
- by email at balconnect.barcelona@gmail.com or
- on twitter Otherwise, you can open an issue in this repository.
If you are willing to get more involved in this project (e.g., become a main contributor/maintainer) you can send us an email at balconnect.barcelona@gmail.com. Please, consider including your contact information and your motivations for becoming part of the core team of contributors.
We value your time and effort. Once you get involved in this project in any way, we are committed to keep you updated with the results.
We are adopting an inclusive and generous authorship model to reflect the work made by the core team, active contributors and the wider community to this project. Please, note that in order for your contribution to be recorded you need to have a GitHub account. Our barrier for entry to the list of contributors is very low. If you have contributed in any of the ways in the table below, then please ask one of the core team to use the all contributors bot 🤖 to add you to the list (you will need to provide us with your GitHub user name). Or comment on an issue or pull request, asking @all-contributors to add a contributor.
@all-contributiors please add @username for name contributions
An example of this is:
@all-contributors please add @adelsarvary for documentation, blogs
A pull request will be automatically generated and this can then be approved and merged by a core team member.
As a contributor, you are also invited to provide more information about your work and your contributions to this project here! To upload your profile, please ask one of the core members, send an email to balconnect.barcelona@gmail.com or open a pull request.
The Balconnect project uses the emoji-key to recognise everyone who contributes to the project.
| Emoji | Represents |
|---|---|
| 🔊 | Audio - Podcasts, background music or sound effects |
| ♿️ | Accessibility - Reporting or working on accessibility issues |
| 🐛 | Bug reports - Reports bugs in reposiory and website |
| 📝 | Blogposts - Writing blogposts |
| 💻 | Code - R code for analysis |
| 🖋 | Content - Publication drafting and editing/revising |
| 🔣 | Data - Contributing or creating data for the project (both tests and datasets) |
| 📖 | Documentation - Creating or editing documentation for the project, Wiki, or other source of documentation |
| 🎨 | Design - Logo, iconography, visual design, etc. |
| 💡 | Examples |
| 📋 | Event organizers |
| 💵 | Financial support - People or organisations who provide financial support |
| 🔍 | Funding/Grant finders - People who help find financial support, help to write or write letters of support for grant applications |
| 🤔 | Ideas and planning |
| 🚇 | Infrastructure - Hosting, build-tools, website building, etc. |
| 🚧 | Maintenance - People who help in maintaining the repository |
| 🧑🏫 | Mentoring - People who mentor new contributors |
| 📦 | Packaging - Porting to support a new platform |
| 🔌 | Plugin/Utility libraries |
| 📆 | Project management |
| 💬 | Answering questions in issues, Stack Overflow, Gitter, Slack, etc. |
| 🔬 | Research - Literature review and survey |
| 👀 | Reviewed pull requests |
| 🛡️ | Security - Identify and/or reduce security threats, GDPR, privacy, etc. |
| 🔧 | Tools |
| 🌍 | Translation - Translated content |
| Tests | |
| ✅ | Tutorials - Creating, helping with tutorials and other educational/training activities |
| 📢 | Talks - Giving talks and making presentations |
| 📓 | User testing |
| 📹 | Videos |
Feel free to get in touch with us by email at balconnect.barcelona@gmail.com or on twitter.