Skip to content

Commit

Permalink
Create Contributing Instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
shivanshudwivedi authored May 8, 2024
1 parent 9a94376 commit f3b5ce3
Showing 1 changed file with 86 additions and 0 deletions.
86 changes: 86 additions & 0 deletions ContributingInstructions
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@

# 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:
- Installed Git on your machine. [Install Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
- A GitHub account. [Sign up here](https://github.com/join)

### 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:
\`\`\`bash
git clone https://github.com/YOUR_USERNAME/YOUR_FORKED_REPO.git
\`\`\`
3. Set up the upstream remote to the original repository so you can fetch updates:
\`\`\`bash
git remote add upstream https://github.com/mhsr21/DexM-Movies.git
\`\`\`

## Making Changes

### Create a Branch

Always create a new branch for your changes:
\`\`\`bash
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:
\`\`\`bash
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:
\`\`\`bash
git fetch upstream
git rebase upstream/main
\`\`\`

### Push Changes to GitHub

Once you're ready to get feedback or merge, push your branch:
\`\`\`bash
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](CODE_OF_CONDUCT.md) 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.

0 comments on commit f3b5ce3

Please sign in to comment.