Skip to content

Latest commit

 

History

History
55 lines (41 loc) · 1.88 KB

CONTRIBUTING.md

File metadata and controls

55 lines (41 loc) · 1.88 KB

Contributing to StandOut Platform

Thank you for considering contributing to StandOut Platform! We're excited to collaborate with you. This document outlines the process and guidelines for contributing to our project.

How Can I Contribute?

1. Reporting Bugs

If you find a bug, please:

  • Search existing issues to ensure the bug hasn’t been reported.
  • If not found, create a new issue with the following details:
    • A descriptive title.
    • Steps to reproduce the bug.
    • Expected and actual behavior.

2. Suggesting Enhancements

If you have ideas for improvements:

  • Search existing issues to avoid duplicates.
  • If not found, open a new issue with:
    • A clear title.
    • A detailed description of the feature/enhancement.
    • Why it would be beneficial.

3. Submitting Code Changes

We welcome pull requests! Follow these steps:

  1. Fork the repository.
  2. Create a new branch (git checkout -b branch-name).
  3. Make your changes.
  4. Test your changes.
  5. Commit with a descriptive message (git commit -m "Add feature X").
  6. Push to your forked repository (git push origin branch-name).
  7. Open a pull request.

4. Writing Documentation

Documentation is just as important as code! You can help by:

  • Improving existing documentation.
  • Adding new documentation for features or changes.

Guidelines for Contributions

  • Commit Messages: Use clear and concise commit messages that describe the change.
  • Branch Naming: Use a descriptive branch name, such as fix/issue-123 or feature/new-dashboard.

Getting Help

If you have questions or need assistance, feel free to:

  • Reach out to the maintainers via discord.

We appreciate your time and effort in contributing to this project. Happy coding! 🚀