How to contribute to FLkit

This project is only possible with the many community contributors. FLkit is an open project where everyone can contribute to the site.

If you wish to contribute, please remember the following:

Follow our style guide.
Ensure your content respects copyright. Please follow our Copyright guidelines.
Acknowledge contributions of yourself and other contributors.

Ways of contributing

Git

If you are familiar with Git, fork the repo and create a pull request.

GitHub

Contribute to the content directly using Markdown templates.

Read the guides

Before starting editing on GitHub:

Make sure you are following our style guide.
Follow the structure of the provided template for the page you wish to create or update.
We use markdown. To learn how to create paragraphs, headings, format text, add links and images and much more, follow our markdown cheat sheet.
Our pages contain metadata. Read more about them in our page metadata guide.

Linking resources and other pages (optional)

If you have mentioned tools or resources in your text, you will have to add them to the tool and resource list.
If you want to list training material or link to other FLkit pages, add it to the page metadata. Read more on how to do this in our page metadata guide.

Important: In general terms, you must avoid manual interlinking of FLkit pages.

Example page

This page sample page demonstrates the types of metadata and links a page can include.

Acknowledgement and ownership of content

Contributors will be shown at the bottom of each page and on the main contributors page if listed in the metadata of the markdown file. We strongly suggest to add the name, ORCID, email address and/or GitHub account and affiliation of the contributor to the CONTRIBUTORS file.

No single contributor or editor owns the site’s content or has the right to dictate what the content should be. The content on the FLkit is community-led, with many people contributing to each section. Hence, decisions are driven by consensus among the contributors and editors.

Since content is periodically updated, others may change your contribution without notifying you. However, the FLkit editors ensure that content is only modified for good reasons, ensuring that all legitimate concerns and different points of view 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.