Contributing - edgeof8/tIRC GitHub Wiki

We welcome contributions to tIRC! Whether you're a seasoned developer or just starting, there are many ways to get involved.

Open Source Spirit: tIRC is an open-source project, and we encourage community participation.

How to Contribute

  • Report Bugs: Found a bug? Please create a detailed issue on our GitHub repository.
  • Suggest Enhancements: Have a great idea? Submit a feature request.
  • Submit Code: Fix bugs, implement features, or improve documentation via pull requests.
  • Write Documentation: Help improve docs with examples and clarifications.
  • Spread the Word: Tell others about tIRC.

Code Style

  • PEP 8: Follow Python style guidelines
  • Docstrings: Document all functions/classes
  • Type Hints: Use type annotations
  • Tests: Write unit tests

Commit Message Format

<type>(<scope>): <subject>

<body>

<footer>

Example:

fix(ui): Fix broken layout on small screens

The layout was broken on small screens due to a CSS issue.

Closes #123

Pull Requests

  1. Create a new branch
  2. Make your changes
  3. Write/update tests
  4. Ensure tests pass
  5. Commit with descriptive message
  6. Create pull request
⚠️ **GitHub.com Fallback** ⚠️