Skip to content

Latest commit

 

History

History
83 lines (61 loc) · 2.81 KB

CONTRIBUTING.md

File metadata and controls

83 lines (61 loc) · 2.81 KB
Raw

Contributing to Requestrr

All help is welcome and greatly appreciated! If you would like to contribute to the project, the following instructions should get you started...

Development

Tools Required

  • HTML/Typescript/Javascript editor
    • VSCode is recommended. Upon opening the project, a few extensions will be automatically recommended for install.
  • .NET CORE SDK 5
  • NPM
  • GIT

Getting Started

  1. Fork the repository to your own GitHub account and clone it to your local device:

    git clone https://github.com/YOUR_USERNAME/requestrr.git
cd requestrr/

  2. Add the remote upstream:

    git remote add upstream https://github.com/darkalfx/requestrr

  3. Create a new branch:

    git checkout -b BRANCH_NAME develop
    • It is recommended to give your branch a meaningful name, relevant to the feature or fix you are working on.
      • Good examples:
        • docs-docker
        • feature-new-system
        • fix-title-cards
      • Bad examples:
        • bug
        • docs
        • feature
        • fix
        • patch

  4. Run the development environment:

     npm run install:clean
 dotnet build
    • Alternatively, you can use Docker with docker build ..

  5. Create your patch and test your changes.

    • Be sure to follow both the code guidelines.
    • Should you need to update your fork, you can do so by rebasing from upstream: 
      git fetch upstream
git rebase upstream/develop
git push origin BRANCH_NAME -f

Contributing Code

  • If you are taking on an existing bug or feature ticket, please comment on the issue to avoid multiple people working on the same thing.
  • All commits must follow Conventional Commits
    • It is okay to squash your pull request down into a single commit that fits this standard.
    • Pull requests with commits not following this standard will not be merged.
  • Please make meaningful commits, or squash them.
  • Always rebase your commit to the latest master branch.
  • It is your responsibility to keep your branch up-to-date. Your work will not be merged unless it is rebased off the latest master branch.
  • You can create a "draft" pull request early to get feedback on your work.
  • Format your code so that it matches the rest of the files.
  • If you have questions or need help, you can reach out via Discord server.

Attribution

This contribution guide was inspired by the Overseerr contribution guides.