Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
232 lines (144 loc) · 3.95 KB

CONTRIBUTING.md

File metadata and controls

232 lines (144 loc) · 3.95 KB
Raw

Contributing to Trivedram

First of all, thank you for considering contributing to Trivedram! ❤️

Every contribution—whether it's a bug report, documentation improvement, feature proposal, design suggestion, or code contribution—helps make our projects better.

We believe that open source thrives when people collaborate with respect, curiosity, and a shared passion for building great software.

Ways to Contribute

There are many ways to contribute to Trivedram.

  • 🐞 Report bugs
  • ✨ Suggest new features
  • 📚 Improve documentation
  • 🎨 Improve UI/UX
  • ⚡ Improve performance
  • 🔒 Help improve security
  • 🧪 Add tests
  • 💻 Write code
  • 🌍 Improve translations (when available)
  • ❤️ Help other contributors

Every contribution matters.

Before You Start

Before opening an issue or submitting a pull request:

  • Search existing issues to avoid duplicates.
  • Read the project's README and documentation.
  • Make sure your idea aligns with the project's goals.
  • If you're unsure, start a discussion first.

Development Workflow

  1. Fork the repository.
  2. Create a new branch from main.
git checkout -b feature/amazing-feature
  1. Make your changes.
  2. Test your changes.
  3. Commit using meaningful commit messages.
  4. Push your branch.
  5. Open a Pull Request.

Branch Naming

Use descriptive branch names.

Examples:

feature/user-authentication
feature/dark-mode
bugfix/login-crash
docs/api-reference
refactor/cache-system
test/auth-module

Commit Messages

Write clear and meaningful commit messages.

Good examples:

feat: add user authentication

fix: prevent application crash on startup

docs: update installation guide

refactor: simplify database connection

test: add authentication unit tests

Avoid messages like:

update

fix

changes

new code

asdf

Code Style

Please write code that is:

  • Clean
  • Readable
  • Consistent
  • Well documented
  • Easy to maintain

Prioritize clarity over cleverness.

Documentation

If your change introduces new functionality, update the documentation whenever appropriate.

Good documentation is just as valuable as good code.

Pull Requests

A good pull request should:

  • Solve one problem.
  • Have a clear description.
  • Include screenshots if the UI changes.
  • Pass all tests.
  • Keep changes focused.

Small pull requests are easier to review than very large ones.

Code Reviews

Code reviews are about improving the project—not criticizing contributors.

Please:

  • Be respectful.
  • Be constructive.
  • Be patient.
  • Be open to feedback.

Everyone is here to learn.

Reporting Bugs

When reporting a bug, please include:

  • Operating system
  • Version
  • Steps to reproduce
  • Expected behavior
  • Actual behavior
  • Screenshots or logs (if available)

The more information you provide, the easier it is to investigate.

Suggesting Features

Feature requests are always welcome.

Please explain:

  • The problem you're trying to solve
  • Your proposed solution
  • Possible alternatives
  • Any additional context

Thoughtful proposals help us make better decisions.

Community Guidelines

We strive to create a welcoming and inclusive environment.

Please:

  • Treat everyone with respect.
  • Assume good intentions.
  • Be kind and professional.
  • Help newcomers whenever possible.
  • Celebrate learning and collaboration.

Harassment, discrimination, or abusive behavior will not be tolerated.

Recognition

Every contribution is appreciated.

Whether you've fixed a typo, reported a bug, improved documentation, or implemented a major feature—thank you for helping Trivedram grow.

Questions?

If you have any questions, feel free to:

  • Open a GitHub Discussion
  • Open an Issue
  • Reach out through our community channels (when available)

We're happy to help.

Thank You

Open source is built by people who choose to share their knowledge and time.

Thank you for being part of the Trivedram community.

Happy coding! 🚀