Contributing to AramSource

1Who Can Contribute

Everyone is welcome. You don't need to be a professional developer. If you can write code, design interfaces, improve documentation, report bugs, or just test things and share feedback, you belong here.

2Ways to Contribute

• Report bugs or unexpected behaviour by opening a GitHub issue.
• Suggest new features or improvements via GitHub Discussions.
• Submit pull requests for bug fixes, features, or documentation.
• Improve translations or add Tamil language support.
• Write or edit documentation to make projects easier to understand.
• Help triage open issues by reproducing bugs and adding context.
• Review open pull requests and leave constructive feedback.

3Before You Start

• Check open issues and pull requests to avoid duplicating work.
• For significant changes, open an issue first to discuss the approach.
• Read the README and any CONTRIBUTING.md file in the specific repository.
• Make sure your change is focused, small, and well-described.

4Pull Request Guidelines

• Fork the repository and create a new branch from main.
• Write clear, descriptive commit messages.
• Keep pull requests focused on a single change or fix.
• Add a description explaining what the PR does and why.
• Include testing notes if the change affects behaviour.
• Do not commit secrets, credentials, or .env files.
• Be responsive to review comments.

5Code Style

Each project may have its own style config (ESLint, Prettier, etc.). Run linting and formatting before submitting. When in doubt, match the style of the existing code in the file you're editing.

6Getting Help

If you're stuck, open a GitHub Discussion or email us at hello@aramsource.org. We want contribution to feel accessible, not intimidating. There are no dumb questions.

7Code of Conduct

All contributors are expected to follow our Code of Conduct. Please read it before participating. Respectful collaboration is non-negotiable.