Skip to content Skip to footer

How to contribute to RDMkit

Ways of contributing

Everyone is welcome to contribute to this site, and we’ve tried to make it as easy as possible. Choose a way that suits you. The website is hosted on GitHub, so:

  • If you are not familiar with Git but want to give it a try on GitHub: follow our step-by-step instructions (no technical knowledge required!).
  • If you are happier using Google Docs: follow the Google Doc way.
  • If you are familiar with Git: fork the repo and create a pull request (see our instructions).
  • If you just want to make a quick suggestion: submit your comments/suggestions using the form below.

Contributor responsibilities

When writing for this website keep in mind the following:

  • For the sake of consistency, please follow our style guide.
  • It is your responsibility to make sure that the content you provide respects copyright. Please follow our Copyright guidelines.
  • Please read our Markdown cheat sheet in order to be able to fill in the page metadata and to format the layout correctly.
  • To avoid having to resolve many issues during the revision process, please check the Editors checklist and make sure you have complied with the requirements.
  • If others were involved in your contribution, by writing up or by providing resources such as diagrams or links, please make sure you acknowledge them in the contributors’ section of your page, after receiving their permission.

Acknowledgement of contributors

Contributors will be shown at the bottom of the page if listed in the metadata of the markdown file. All contributors will also be displayed in the contributors page. If you want to link your GitHub account, ORCID or email address, please add your name and corresponding information to the CONTRIBUTORS file.

Ownership of content

No single contributor or editor owns the content of the site, or has the right to dictate what the content should be. The content on the RDMkit is a community effort, with many people contributing. Decisions are driven by consensus among the contributors and editors.

The content is periodically updated, which means that if you create content in an RDMkit page, others can change the content without notifying you. However, the RDMkit editors ensure that content is only modified for good reasons. The RDMkit editors try to ensure that the legitimate concerns and different point of views of all contributors are accommodated, and that the content reflects the most popular consensus on any given topic.

If you find any content unsatisfactory, please feel free to create an issue about it.

Making a quick suggestion