Skip to content

Initialize a contributing guide #384

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cmd-ntrf wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Initialize a contributing guide #384

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a04eeba
Initialize a contributing guide
cmd-ntrf Oct 29, 2025
e9cb8a6
Add todos
cmd-ntrf Oct 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Contributing to Magic Castle

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

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.

--