From a04eebace9960cd3b9b1ea25199d76c1939522ce Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A9lix-Antoine=20Fortin?= Date: Wed, 29 Oct 2025 14:24:53 -0400 Subject: [PATCH 1/2] Initialize a contributing guide --- CONTRIBUTING.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..893fa0c4 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,19 @@ +# Contributing to Magic Castle + +Thank you for your interest in contributing to Magic Castle! + + +## How to Contribute + +All contributions — whether fixing a typo, improving documentation, or adding major features — are welcome. +Before contributing, please take a moment to read our [Code of Conduct](https://github.com/computecanada/magic_castle/blob/main/CODE_OF_CONDUCT.md). + +### 1. Reporting Issues and Requesting Features +If you find a bug or have a feature request: +1. Search the [existing issues](https://github.com/computecanada/magic_castle/issues) to see if it has already been reported. +2. If not, open a new issue using the appropriate template. + - Clearly describe the problem or enhancement. + - Include environment details (cloud provider, Terraform version, etc.) when relevant. +3. In the event that the issue is related to one of Magic Castle’s subprojects, a maintainer may transfer your issue to the appropriate GitHub repository. You don’t need to determine the correct repository yourself. The maintainers will handle that for you. + +-- \ No newline at end of file From e9cb8a6717d4418a993e97b603d0f6ebebef97c6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A9lix-Antoine=20Fortin?= Date: Thu, 30 Oct 2025 15:44:46 -0400 Subject: [PATCH 2/2] Add todos --- CONTRIBUTING.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 893fa0c4..c77fa323 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,6 +2,19 @@ Thank you for your interest in contributing to Magic Castle! +## What kind of contributions can I make? + +### Improving documentation + +[TODO] + +### Improving code + +[TODO] + +### Improving tests + +[TODO] ## How to Contribute