Skip to content

Latest commit

 

History

History
82 lines (55 loc) · 3.4 KB

CONTRIBUTING.md

File metadata and controls

82 lines (55 loc) · 3.4 KB

Contributing to the Project

Date Status Decided By Description
10/12/2023 Accepted - Nick Bauters Initial version

Case description

This document provides guidelines for contributing to the project and describes where everything is documented. This document should always be read before querying the project owner for questions and contribution requests.

General Approach

Querying for contribution

If you want to contribute to this project, you can contact the project owner via GitHub. Before contacting, make sure to at least read this document thoroughly.

  1. Read the README file.
  2. Read the Contributing guidelines
  3. Read the Cooperative rulesets
  4. Read the Architectural decisions
  5. Query the project owner
  6. Wait for response
  7. The project owner will investigate your query
  8. The project owner will respond to the query
  9. When positive 10. You will receive links to the project 11. A branch will be created for an update to the contribution guidelines and readme file.

Contributor guidelines

  1. Declares to have read all the required documentation and agrees to these documents.
  2. Declares to follow all set rules and guidelines.

Quit contributing

A contributor will automatically stop being a contributer when:

  • The project is finished
  • The contributor is no longer contributing to the project for over 6 months
  • The contributer whishes to stop contributing and has communicated this to the project owner

Current Contributors

Name Role Started Stopped
Nick Bauters Project Owner 10/12/2023 not applicable

Rules and Guidelines

Cooperative rulesets

Cooperative rulesets are basic documents that describe how to work together on this project. These documents are archived in markdown and can be found in the Cooperative documentation folder.

These documents are ordered in specific cases and contain the context of the case, the general aproach to the case. And addition information.

Currently, the following cases are available:

Architectural decisions

Architectural decisions are decisions that are made during the development of the project. These decisions start as investigations and are documented in the Architectural decisions folder.

The investigative nature of these documents, means that they are not always correct and or implemented. You should always read the entire document and pay extra attention to the decision outcome.

Currently, the following decisions are available:

Documentation

Not applicable

Decision Log

No adjustments made to the decision log.