Contributing Guidelines

Warning

🚧 This section is still in active development and is subject to changes 🚧

Individual guide entries

These entries are small pages about a specific topic for contributing and anyone can submit an entry to be added (or modify an existing one).

For team-specific contributing guidelines, check out our team.seedcase-project.org website.

Decisions on choices

For transparency and recordkeeping, we try to document and explain why we make the decisions we make when it comes to building and organizing the community.

Why Ruff

Enforcing style of code with automatic linters and formatters is important for code reviews to focus on content, not style. This post covers the reasons why we decided on Ruff for our linting and formatting purposes.
Nov 27, 2023
Richard Ding, Luke Johnston

Why an MIT License

Open and permissive licensing of copyrighted content is a way to increase use of a software product, ease collaboration and re-use, and sharing intellectual ideas with others. This post contains our reasons for choosing the MIT License, which is a very permissive copyright license.
Apr 1, 2023
Kristiane Beicher

Why choose Discord?

Our reasons for using Discord as our communication platform.
Dec 2, 2023
Luke W. Johnston

Why choose Quarto?

Our reasons for using Quarto to build the website and write the general documentation.
Dec 2, 2023
Luke W. Johnston

Why standardise shortcuts for writing documentation

The larger a project is, the more important it becomes to have a joint set of standards when writing documentation. We decided to set up shortcuts that are shared across the team, so that all documentation follows the same classification and formatting.
Dec 2, 2023
Kristiane Beicher

Why text/code-based tools?

Our reasons for selecting tools that are based on code, rather than GUIs.
Dec 2, 2023
Luke W. Johnston

Why use GitHub Projects for project management

As a project grows, it becomes both more important and more difficult to keep track of where the project is at. This can be helped by using visualisation and project management tools like GitHub Projects.
Dec 2, 2023
Kristiane Beicher

No matching items

Code of Conduct

Please note that the Seedcase project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.