Skip to content

Latest commit

 

History

History
86 lines (59 loc) · 2.53 KB

CONTRIBUTING.md

File metadata and controls

86 lines (59 loc) · 2.53 KB
Raw

Collaboration Guidelines

Welcome to our project! We're excited to have you contribute. To ensure a smooth collaboration process, we've outlined some guidelines that you should follow when contributing to this project.

Getting Started

Prerequisites

Before contributing, ensure you have:

Fork and Clone the Repository

To contribute, you'll need to fork the repository and clone it to your machine:

  1. Fork the repository by clicking the "Fork" button on the top-right corner of this page.
  2. Clone your forked repository to your local machine: 
    git clone (https://github.com/mhsr21/DexM-Movies.git)
  3. Set up the upstream remote to the original repository so you can fetch updates: 
    git remote add upstream https://github.com/mhsr21/DexM-Movies.git

Making Changes

Create a Branch

Always create a new branch for your changes:

git checkout -b your-branch-name

Make Your Changes

Implement your changes or improvements. Be sure to:

  • Follow the coding style and conventions already in place.
  • Include comments in your code where necessary.

Commit Your Changes

Make commits that are small and logically separated:

git add .
git commit -m "A brief description of the changes"

Keep Your Branch Updated

Regularly pull changes from the upstream repository to keep your branch up-to-date:

git fetch upstream
git rebase upstream/main

Push Changes to GitHub

Once you're ready to get feedback or merge, push your branch:

git push origin main

Submitting a Pull Request (PR)

Go to the repository on GitHub, and you'll see a prompt to open a pull request. Click the "Compare & pull request" button and:

  1. Ensure the base repository is correct.
  2. Provide a concise and informative title.
  3. Include a detailed description of your changes.
  4. Mention any relevant issue numbers.

Review and Merge

  • Wait for the project maintainers to review your PR. They might request some changes.
  • Once approved, a maintainer will merge your PR.

Code of Conduct

Please follow our Code of Conduct in all your interactions with the project.

Questions?

If you have any questions or need further clarification, feel free to open an issue or contact the project maintainers.

Thank you for contributing to our project! We look forward to seeing your contributions.