| layout | title | nav_order | has_children |
|---|---|---|---|
default |
Contributing |
4 |
true |
First of all, thank you for considering to contribute to this initiative! 🌾
The FAIR Phytoliths project has grown from initial efforts by Emma Karoune to raise awareness on limited data sharing within the community of phytolith researchers. This initiative is supported by the International Phytolith Society (IPS) and represents the first steps towards the FAIRification of phytolith data.
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 FAIR Phytoliths 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 who deals with phytoliths, either in academia or in the private sector, can participate in this project. There are different ways in which you can contribute and hence different degrees of involvement:
-
Help us to gather information about current data sharing practices and opinions on why open practices are not very common within the phytolith community and how we can improve as a community, by filling this survey.
-
Provide phytolith datasets from South American and European studies in which you participated to help us assessing them and establishing the breadth of phytolith data (including archaeological, palaeoecological, modern botanical studies, etc.). You can send them by email at [email protected]. Datasets can be already published fully or partially, or even unpublished: we will not share them unless you give us permission to do so!
-
Submitting feedback about any aspect of the project. You can reach us by email at [email protected] 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 [email protected]. 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 phytolith 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 @EKaroune 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 [email protected] or open a pull request.
The FAIR Phytoliths 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 |
If you would like to be more involved in the project, want to make a substantial contribution that goes beyond a one-off task, and want to be a named author on a publication, please see our authorship guidelines that include authorship criteria and an author name ordering process.
Feel free to get in touch with us by email at [email protected] or on twitter.