Contributing to Openmadness 📘

Thank you for your interest in contributing to Openmadness! Whether you're spotting typos, improving docs, or adding new features, your help is greatly appreciated. 😊

How Can I Contribute?

There are many ways to help:

Fixing typos or documentation errors
Adding examples, tutorials, or clarifying explanations
Implementing missing features or expanding existing ones
Proposing improvements to layout, navigation, or style

We welcome and value all contributions—small fixes are just as important as large additions.

Good First Issues & Where to Look

To help you get started, issues tagged good first issue or help wanted are ideal. Check the issue tracker and comment if you'd like to take one on.

Reporting Bugs or Typos

Please open an Issue with:

A descriptive title
Steps to reproduce the bug or typo
Suggested correction or documentation link (if applicable)

Use the issue template if available.

Submitting Changes (Pull Requests)

Fork the repo
Create a new branch: git checkout -b my-feature
Make commits with clear, concise messages (see guidelines below)
Push to your fork: git push origin my-feature
Open a PR against the main branch

PRs should reference related issues (e.g., “Fixes #123”) and include a helpful description. Expect review feedback and please respond positively to suggestions.

Development Setup

To work on the docs locally:

git clone https://github.com/YourOrg/open-madness-docs.git
cd open-madness-docs
# If built with a static-site generator:
npm install
npm run dev

Adjust with your specific build or test setup.

Coding & Formatting Standards

Markdown files: follow CommonMark conventions
Use meaningful headings and consistent structure
Run a linter or formatter (e.g., Prettier) if configured

Commit Message Guidelines

Write commit messages that are clear and descriptive. Use this format:

<type>: Short summary
Detailed explanation, if needed.

Types include: feat, fix, docs, style, refactor, test, chore.

Example:

docs: correct typo in getting-started guide

Review Process

PRs will be reviewed in 1–2 weeks
You may be asked for changes—please don’t be discouraged!
Once approved, your PR will be merged and linked to the corresponding issue

Non‑Code Contributions

Contributions beyond code are welcome:

📄 Writing or improving documentation, tutorials
🎨 Enhancing design, layout, or UX
🧪 Creating examples or test cases
📢 Sharing Open Madness with others

Let us know how you'd like to help!

Code of Conduct

Please follow our CODE_OF_CONDUCT.md to help maintain a respectful, inclusive community.

Contact & Communication

Need help or want to suggest something?

Join us on Discord/Slack: [invite link]
Post an issue with the discussion or help wanted label
Reach out to maintainers: wisdom@openmadness.com

Let’s make Open Madness amazing—together!

Add to README.md: Under “Contributing” in your README, link to this file:
See [CONTRIBUTING.md](CONTRIBUTING.md) to get started contributing!