Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
65 lines (48 loc) · 2.42 KB

CONTRIBUTING.md

File metadata and controls

65 lines (48 loc) · 2.42 KB

Contributing Guidelines

Help us build lasting value through thoughtful, high‑quality contributions to open source.
At ACM‑VIT, we prioritize clarity, impact, and collaboration.

How to Get Started

  1. Fork the repository
  2. Clone your fork locally
  3. Create a new branch for your changes
  4. Make edits and commit with a clear message
  5. Push your branch and open a Pull Request (PR)
  6. Reference related issues in your PR description

How to Contribute

  • Fix existing issues or bugs (link your PR to the issue with "Fixes #")
  • Improve documentation (readmes, examples, API docs) or add tests that increase coverage and confidence
  • Add small, scoped features or enhancements with clear rationale and usage notes
  • Refactor code to improve readability/performance without changing behavior (state what changed and why)
  • Review and refine others’ PRs with constructive, actionable feedback
  • Non‑code contributions (design, translations, UX copy, tutorials) are welcome when submitted via PR and scoped to this repo’s needs

Pull Request Guidelines

  • Follow the PR template provided
  • Keep commits focused and descriptive
  • PRs can be WIP (Work in Progress), mention it in the title
  • Ensure your code is linted, tested, and functional

Hacktoberfest

Opening Issues

  • For bugs: include reproduction steps, expected vs. actual behavior, environment details (OS, versions), logs/screenshots, and minimal code snippets if relevant.
  • For feature requests: explain the problem, proposed solution, alternatives considered, and any UX impact.
  • For documentation: link the page/section, specify what’s unclear or missing, and propose suggested wording if possible.
  • Security: do not open public issues. Report critical concerns privately to the maintainers (use the contact in the Code of Conduct).

Communication

  • Be concise and respectful
  • Give context when reporting or suggesting
  • Research before asking for help
  • Respect review feedback and community decisions

Code of Conduct

This project adheres to a Code of Conduct.
Participation implies agreement to its terms.

Attribution

Adapted from the Open Source Guides – How to Contribute.