Skip to content

Latest commit

 

History

History
79 lines (53 loc) · 4.03 KB

CONTRIBUTING.md

File metadata and controls

79 lines (53 loc) · 4.03 KB
Raw

Contributing to VisionGuard

First off, thank you for considering contributing to VisionGuard! It's people like you that make VisionGuard such a great tool.

Table of Contents

  1. Code of Conduct
  2. Getting Started
  3. Development Setup
  4. Coding Standards
  5. Commit Guidelines
  6. Documentation

Code of Conduct

We are committed to fostering a welcoming and inclusive community. As contributors and maintainers of VisionGuard, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests, and other activities.

We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality.

Examples of unacceptable behavior by participants include:

  • The use of sexualized language or imagery
  • Personal attacks
  • Trolling or insulting/derogatory comments
  • Public or private harassment
  • Publishing others' private information, such as physical or electronic addresses, without explicit permission
  • Other unethical or unprofessional conduct

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project.

This code of conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [INSERT EMAIL ADDRESS]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident.

Getting Started

Issues

  • Before creating an issue, please check the existing issues to avoid duplicates.
  • When creating an issue, provide a clear title and description with as much relevant information as possible.

Pull Requests

  1. Fork the repo and create your branch from main.
  2. If you've changed APIs, update the documentation.
  3. Ensure your code follows the existing coding standards.
  4. Issue that pull request!

Development Setup

For detailed instructions on setting up the development environment, building the project, and running the application, please refer to our DEVELOPMENT.md file. This document provides comprehensive guidance for both Windows and Unix-based systems.

Coding Standards

  • Use consistent indentation (spaces) throughout the codebase.
  • Follow the existing code style in the project.
  • Write clear, readable, and well-commented code.
  • Use meaningful variable and function names.
  • Keep functions small and focused on a single task.

Commit Guidelines

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line

Documentation

  • Update the README.md with details of changes to the interface.
  • Update the USAGE.md if you change or add any user-facing functionality.
  • Add or update code comments where necessary.
  • If you add new features, consider updating the ARCHITECTURE.md file.

Remember, contributions to VisionGuard should be a fun and rewarding experience. If you have any questions or need help, don't hesitate to reach out to the maintainers or the community.

Thank you for your interest in improving VisionGuard!