Skip to content

Latest commit

 

History

History
97 lines (70 loc) · 4.16 KB

contributing.md

File metadata and controls

97 lines (70 loc) · 4.16 KB

Reel Rec | Contributions

Table of Contents

  1. Introduction
  2. How To Contribute
  3. How to Report Bugs
  4. How to Suggest Features
  5. Guidelines
  6. Getting Help
  7. Acknowledgements

Introduction

Thank you for considering contributing to Reel Rec! We welcome all contributions that will help improve the project. Please take a moment to review this guide to make the process smooth.

How to Contribute

1. Fork the Repository

Fork the repository to your own GitHub account by clicking the "Fork" button at the top right of the repository page.

2. Clone Your Fork

Clone your forked repository to your local machine using the following command:

git clone https://github.com/[your_username]/Reel-Rec.git

3. Create a New Branch

Create a new branch for your feature or bug fix:

git checkout -b feature/[your_feature-name]

4. Make Your Changes

Make the necessary changes to the codebase. Ensure your code follows the project's coding standards and optionally includes appropriate tests.

5. Commit Your Changes

Commit your changes with a clear and descriptive commit message:

git commit -m "Add feature: description of your feature"

6. Push to Your Fork

Push your changes to your forked repository:

git push origin feature/[your_feature-name]

7. Create a Pull Request

Create a pull request from your forked repository to the main repository. Provide a clear description of your changes and the problem they solve.

How to Report Bugs

If you find a bug in the project, please help us by reporting it. Here are the steps to report a bug:

  1. Check for Existing Issues Before reporting a new bug, please check the existing issues to see if the bug has already been reported.

  2. Open a New Issue If the bug has not been reported, open a new issue on GitHub. Provide the following information:

    • Title: A clear and descriptive title for the issue.
    • Description: A detailed description of the bug, including steps to reproduce the issue.
    • Environment: Information about your environment, such as the browser & version of the dependencies.
    • Screenshots: If applicable, include screenshots to help illustrate the problem.

  3. Submit the Issue Once you have provided all the necessary information, submit the issue. We will review it and take appropriate action.

How to Suggest Features

We welcome suggestions for new features that can improve the project. Here are the steps to suggest a feature:

  1. Check for Existing Suggestions Before suggesting a new feature, please check the existing issues to see if the feature has already been suggested.

  2. Open a New Issue If the feature has not been suggested, open a new issue on GitHub. Provide the following information:

    • Title: A clear and descriptive title for the feature suggestion.
    • Description: A detailed description of the feature, including its purpose and benefits.
    • Use Cases: Describe specific use cases or scenarios where the feature would be useful.
    • Mockups or Examples: If applicable, include mockups, diagrams, or examples to help illustrate the feature.

  3. Submit the Suggestion Once you have provided all the necessary information, submit the issue. We will review it and consider it for future development.

Guidelines for Contributions

  • Code Quality: Ensure your code is well-documented and follows the project's coding standards.
  • Commit Messages: Use clear and descriptive commit messages.
  • Pull Requests: Provide a detailed description of your changes and the problem they solve.

Getting Help

If you need any help, feel free to open an issue on GitHub or reach out to me.

Acknowledgements

Thank you to all the contributors who have helped make this project better!