Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
95 lines (68 loc) · 2.11 KB

CONTRIBUTING.md

File metadata and controls

95 lines (68 loc) · 2.11 KB

Contributing to Open Launch

Thank you for your interest in contributing to Open Launch! This document provides guidelines and instructions for contributing to the project.

🤝 Code of Conduct

Please be respectful and considerate of others. We follow the Contributor Covenant Code of Conduct.

🚀 Getting Started

  1. Fork the repository
  2. Clone your fork: 
    git clone https://github.com/your-username/open-launch.git
cd open-launch
  3. Install dependencies: 
    npm install
  4. Create a new branch: 
    git checkout -b feature/your-feature-name

📝 Pull Request Process

  1. Ensure your code follows our coding standards
  2. Update the documentation if necessary
  3. Add tests for new features or bug fixes
  4. Ensure all tests pass
  5. Submit a pull request with a clear description of changes

🧪 Testing

Before submitting a pull request, please ensure:

  1. All tests pass: 
    npm test
  2. Linting passes: 
    npm run lint

📚 Documentation

  • Update README.md if necessary
  • Add comments to complex code sections
  • Document new features in the appropriate documentation files

🐛 Reporting Bugs

When reporting bugs, please include:

  1. A clear description of the bug
  2. Steps to reproduce
  3. Expected behavior
  4. Actual behavior
  5. Screenshots if applicable
  6. Environment details (OS, browser, etc.)

💡 Feature Requests

For feature requests:

  1. Describe the feature in detail
  2. Explain why it would be valuable
  3. Provide examples if possible

🏷️ Commit Messages

Please follow these guidelines for commit messages:

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

📦 Release Process

  1. Update version numbers
  2. Update CHANGELOG.md
  3. Create a new release on GitHub
  4. Tag the release

🤝 Questions?

Feel free to:

  • Open an issue
  • Contact the maintainers

Thank you for contributing to Open Launch! 🚀