Skip to content

Latest commit

 

History

History
65 lines (51 loc) · 2.41 KB

CONTRIBUTING.md

File metadata and controls

65 lines (51 loc) · 2.41 KB

Contributing to Dcet Prep App

We welcome contributions to our project! Whether you're reporting a bug, suggesting new features, or contributing code, your efforts are greatly appreciated. Here's how you can get involved:

📋 Reporting Issues

To help us understand and resolve issues faster:

  1. Check for duplicates: Ensure the issue hasn’t already been reported.
  2. Use a clear title: Describe the problem in a concise way.
  3. Provide details:
    • Steps to reproduce the issue.
    • Expected behavior vs. actual behavior.
    • Screenshots, logs, or error messages if applicable.
  4. Submit your report: Use the Issues tab and select the appropriate template.

💡 Suggesting Features

Have an idea for improvement? We'd love to hear it!

  1. Search existing suggestions: Ensure your feature request hasn’t already been proposed.
  2. Use the feature request template: Provide:
    • A brief overview of the feature.
    • The problem it solves.
    • Why it’s valuable to the project.
  3. Submit your idea: Use the Feature Request option.

🛠️ Contributing Code

Before You Begin

  • Ensure your changes align with the project goals and roadmap.
  • Open a discussion in the repository if the change is significant.

Steps to Contribute

  1. Fork the repository: Clone it locally.
  2. Create a new branch: Use a descriptive name (e.g., fix-login-bug).
  3. Write clean code: Follow the project's coding conventions and style.
  4. Add tests: Ensure your changes are well-tested.
  5. Commit your changes:
    • Use descriptive commit messages.
    • Group related changes in a single commit.
  6. Push to your branch.
  7. Submit a Pull Request: Link to any related issues or feature requests.

🔄 Pull Request Process

  1. Ensure your changes are up-to-date with the main branch.
  2. Provide a clear description of your changes.
  3. Include references to any related issues or feature requests.
  4. Be ready to address feedback during the review process.

📜 Issue & Pull Request Templates

We’ve created templates to streamline contributions:

  • Use the Bug Report template for issues.
  • Use the Feature Request template for suggestions.
  • Provide relevant details for Pull Requests.

❤️ Thanks for Contributing!

We value your input and support!