Skip to content

Latest commit

 

History

History
145 lines (97 loc) · 5.16 KB

File metadata and controls

145 lines (97 loc) · 5.16 KB

Contributing to Projects

Thank you for your interest in contributing to Projects! 🎉

About This Repository

This repository is the public issue tracker and roadmap for Projects. The source code is maintained privately by our organization. However, we welcome and value community contributions in the following areas:

How to Contribute

Reporting Bugs 🐛

Bug reports help us improve Projects for everyone. When reporting bugs:

  1. Search first: Check if the issue has already been reported
  2. Use the template: Select the "Bug Report" template when creating an issue
  3. Be specific: Include clear steps to reproduce, expected vs. actual behavior
  4. Provide context: Include version numbers, OS details, and relevant logs
  5. Stay engaged: Be available to answer follow-up questions

Suggesting Features 💡

We love hearing ideas from our community! When suggesting features:

  1. Search first: Check if the feature has already been suggested
  2. Use the template: Select the "Feature Request" template when creating an issue
  3. Explain the problem: Describe the use case and problem you're trying to solve
  4. Provide examples: Show how the feature would be used in real scenarios
  5. Be patient: Feature requests are evaluated based on user impact and feasibility

Asking Questions ❓

Have questions about using Projects?

  1. Check documentation: Look for existing documentation first
  2. Search issues: Someone may have already asked
  3. Use the template: Select the "Question" template when creating an issue
  4. Be clear: Provide enough context to help us understand your question

Improving Documentation 📖

Documentation improvements are always welcome! You can contribute by:

  • Fixing typos or unclear explanations
  • Adding examples or clarifications
  • Improving issue templates
  • Updating the README or guides

To contribute documentation:

  1. Fork this repository
  2. Make your changes in a branch
  3. Submit a pull request with a clear description of your changes

Community Discussions 💬

Engage with the community through:

  • Issue comments (be constructive and respectful)
  • GitHub Discussions (if enabled)
  • Helping answer questions from other users

Issue Triage Process

Our team regularly reviews new issues:

  1. Triage: Issues are labeled and categorized
  2. Evaluation: We assess priority and feasibility
  3. Planning: Accepted items are added to our roadmap
  4. Implementation: Work is tracked through milestones and projects
  5. Updates: We keep the community informed through issue comments

Labels

We use labels to organize and track issues:

  • bug - Something isn't working
  • enhancement - New feature or request
  • question - Further information is requested
  • documentation - Improvements or additions to documentation
  • needs-triage - Awaiting initial review
  • priority: critical - Urgent issues blocking users
  • priority: high - Important issues affecting many users
  • priority: medium - Issues that should be addressed
  • priority: low - Nice to have improvements
  • status: accepted - Issue is confirmed and will be addressed
  • status: in-progress - Work is underway
  • status: completed - Issue has been resolved
  • wontfix - Issue won't be addressed
  • duplicate - Issue already exists elsewhere
  • invalid - Issue doesn't meet requirements

Code of Conduct

This project adheres to a Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior through the appropriate channels.

Communication

  • Issues: Primary method for bug reports and feature requests
  • Pull Requests: For documentation and template improvements
  • Comments: For follow-up discussions on specific issues

Response Times

We strive to respond to issues in a timely manner:

  • Critical bugs: Within 24-48 hours
  • Regular bugs: Within 3-5 business days
  • Feature requests: Within 1-2 weeks for initial triage
  • Questions: Within 3-5 business days

Please note these are targets, not guarantees. Response times may vary based on team availability and issue complexity.

What We're Looking For

High-quality contributions that help us understand:

  • Clear problem descriptions: What's wrong or missing?
  • Reproducible steps: How can we see the issue?
  • Impact assessment: Who is affected and how severely?
  • Constructive suggestions: What would make it better?

What to Avoid

  • Duplicate issues (search first!)
  • Vague or incomplete reports
  • Demands or entitled behavior
  • Off-topic discussions
  • Spam or promotional content

Recognition

We appreciate all contributions! Contributors who provide valuable feedback, thorough bug reports, or helpful suggestions may be acknowledged in release notes.

Questions?

If you're unsure about anything, feel free to ask! Create an issue with the "Question" template or reach out through available communication channels.

License

By contributing to this repository, you agree that your contributions will be licensed under the same terms as the project.


Thank you for helping make Projects better! Your contributions, whether big or small, are valued and appreciated. 🚀