Skip to content

Latest commit

 

History

History
120 lines (81 loc) · 4.03 KB

CONTRIBUTING.md

File metadata and controls

120 lines (81 loc) · 4.03 KB

Contributing to MMSpace

We love your input! We want to make contributing to MMSpace as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

Development Process

We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.

Pull Requests

Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Issue that pull request!

Any contributions you make will be under the MIT Software License

In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

Report bugs using GitHub's issue tracker

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!

Write bug reports with detail, background, and sample code

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Give sample code if you can
  • What you expected would happen
  • What actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

Development Setup

  1. Clone the repository
  2. Install dependencies: npm run install-all
  3. Set up environment variables (see README.md)
  4. Start development servers: npm run dev

Code Style

  • Use ESLint and Prettier for code formatting
  • Follow React best practices
  • Use meaningful variable and function names
  • Add comments for complex logic
  • Keep functions small and focused

Testing

  • Write unit tests for new features
  • Ensure all tests pass before submitting PR
  • Test on multiple browsers and devices
  • Test both light and dark modes

Commit Messages

  • Use clear and meaningful commit messages
  • Start with a verb (Add, Fix, Update, Remove, etc.)
  • Keep the first line under 50 characters
  • Reference issues and pull requests when applicable

Example:

Add user profile editing functionality

- Implement edit mode toggle
- Add form validation
- Update API endpoints
- Fixes #123

Feature Requests

We welcome feature requests! Please provide:

  • Clear description of the feature
  • Use case and benefits
  • Possible implementation approach
  • Any relevant mockups or examples

Code of Conduct

Our Pledge

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

Our Standards

Examples of behavior that contributes to creating a positive environment include:

  • Using welcoming and inclusive language
  • Being respectful of differing viewpoints and experiences
  • Gracefully accepting constructive criticism
  • Focusing on what is best for the community
  • Showing empathy towards other community members

Enforcement

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

License

By contributing, you agree that your contributions will be licensed under its MIT License.

References

This document was adapted from the open-source contribution guidelines for Facebook's Draft