Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
80 lines (58 loc) · 2.84 KB

CONTRIBUTING.md

File metadata and controls

80 lines (58 loc) · 2.84 KB

Contributing to PsychOS

First off, thank you for considering contributing to PsychOS! We appreciate any help you can provide—whether it’s reporting bugs, suggesting new features, or submitting pull requests.

Please read through this document before contributing. It will help you get started quickly and keep things organized.

Table of Contents

  1. Code of Conduct
  2. How to Contribute
  3. Reporting Bugs
  4. Suggesting Features
  5. Pull Requests
  6. Style Guidelines
  7. Contact

Code of Conduct

By participating in this project, you agree to abide by the Code of Conduct. Please take a moment to review it.

How to Contribute

  • Check existing issues and discussions to see if your idea or problem is already addressed.
  • If you want to fix a bug or implement a feature, open an issue first to discuss it with the maintainers (unless it’s a trivial fix).

Reporting Bugs

  1. Search existing issues to see if it’s already been reported.
  2. If not, create a new issue:
    • Clearly describe the problem, including steps to reproduce it.
    • Include relevant details about your environment (OS, version, etc.).
    • Add screenshots or logs if helpful.

Suggesting Features

  1. Search existing issues to see if your feature has already been suggested.
  2. If not, create a new feature request issue:
    • Explain why the feature is useful and how it would be used.
    • Provide any examples or sketches if possible.

Pull Requests

  1. Fork the repository and create a new branch for your changes.
  2. Make your changes in your branch.
  3. Commit your changes with a descriptive commit message.
  4. Push your branch to your fork.
  5. Open a Pull Request (PR) against the main (or appropriate) branch of PsychoDuckTech/PsychOS.
  6. In your PR description:
    • Reference the issue it fixes or addresses if applicable (e.g., “Closes #123”).
    • Briefly summarize your changes.
    • Mention any outstanding questions or areas you’re unsure about.

The maintainers will review your PR. If you receive feedback, try to address it promptly by pushing additional commits.

Style Guidelines

  • Coding Style: Follow the style or format already in the codebase. If you’re unsure, ask in an issue or discussion.
  • Documentation: If you add or modify functionality, update documentation or comments where applicable.
  • Commits: Write clear, descriptive commit messages.

Contact

If you have any questions or need help getting started, you can reach out via:

  • Issues: Open a new issue
  • Email: [INSERT CONTACT EMAIL OR PROJECT MAILING LIST]

We’re happy to help! Thanks again for your interest in improving PsychOS.