Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
64 lines (44 loc) · 3.46 KB

CONTRIBUTING.md

File metadata and controls

64 lines (44 loc) · 3.46 KB

🤝 Contributing

First and foremost, thank you for taking the time to contribute! 🎉 Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. 💖

📜 Code of Conduct

This project and everyone participating in it is governed by a Code of Conduct. By participating, you are expected to uphold this code. 🛡️ Please report unacceptable behavior.

🤔 How Can I Contribute?

🐛 Reporting Bugs

This section guides you through submitting a bug report for detect-primary-camera. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports. 🕵️‍♂️

  • Check existing issues: Before creating a new issue, please check the existing issues to see if the problem has already been reported. 🔍
  • Use the bug report template: If no existing issue exists, please follow the bug report template provided in the issue tracker (if available). 📝
  • Provide clear steps to reproduce: Explain exactly how to reproduce the bug. 👣
  • Include context: What were you trying to achieve? What device/OS/browser were you using? 📱💻

💡 Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for detect-primary-camera, including completely new features and minor improvements to existing functionality. 🚀

  • Check existing issues: Before creating a new enhancement suggestion, please check the existing issues. 🔎
  • Use the feature request template: If no existing issue exists, please follow the feature request template provided in the issue tracker (if available). 📋
  • Be specific: Clearly describe the enhancement and its purpose. 🎯
  • Provide examples: Explain how the enhancement would be used. 🏗️

🛠️ Pull Requests

The process described here has several goals:

  • Maintain detect-primary-camera's quality 🌟
  • Fix problems that are important to users 🩹
  • Engage the community in working toward the best possible open source primary camera detection library. 🌍
  • Enable a sustainable system for detect-primary-camera's maintainers to review contributions 🔄

Please follow these steps to have your contribution considered by the maintainers:

  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! 🚀

💻 Development Setup

  1. Clone your fork of the repository: git clone https://github.com/YOUR_USERNAME/detect-primary-camera.git 📥
  2. Install dependencies: npm install 📦
  3. To build the library: npm run build 🏗️

🎨 Styleguides

📝 Git Commit Messages

  • 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 🔗

💅 Code Style

This project uses standard web development practices and tools like Biome for formatting and linting. 🧹 Please ensure your code conforms to the project's formatting rules before submitting a PR. You can run npm run lint or npm run format locally. 🛠️