CONTRIBUTING.md

Contributing to Mico Leão Dublado (EN)

👍🎉 First off, thanks for taking the time to contribute! 👍🎉

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to victorgvbh@gmail.com.

The following is a set of guidelines for contributing to Mico Leão Dublado. These are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request.

• How to Contribute in Issues

• Asking for General Help? Ask on r/StremioAddons or on Discord

• Do you miss a movie (or any other content) on a Mico Leão Dublado API server? Wrong place! This is a project focused on DEVELOPING Mico Leão Dublado. There is no Mico Leão Dublado official public server. We only host instances of Mico Leão Dublado API for testing purpose only!
  

• Reporting a Bug

• Submitting a Feature Request

• Submitting a Pull Request (Please read our license terms before contributing!)

Issues

Issues are created here. Alternatively, you can select the Issue Tab highlighted in the image below.

How to report bugs?

1. Press the "New Issue" Button:

   • 

2. Select Bug Report:

   • 

3. Follow the instructions on the Bug Report Template. Remember:

   • to choose a descriptive title
   • to be concise
   • to replace only the highlighted text in the image below:

   

How to submit a Feature Request?

1. Press the "New Issue" Button:

   • 

2. Select Feature Request:

   • 

3. Follow the instructions on the Feature Request Template. Remember:

   • choose a descriptive title
   • be concise
   • replace only the highlighted text in the image below:

   

Languages

We accept issues in both English and Portuguese. When an issue is posted in a language besides English (or Portuguese), it is acceptable and encouraged to post an English-translated copy as a reply. Anyone may post the translated reply. In most cases, a quick pass through translation software is sufficient. Having the original text as well as the translation can help mitigate translation errors.

Responses to posted issues may or may not be in the original language.

Pull Requests

Pull Requests are the way concrete changes are made to the code and documentation in this repository.

• Setting up your local environment
  • Step 0: (If you are using Windows) Install WSL 2
  • Step 1: Fork it!
  • Step 2: Inside WSL 2 or a Linux distribution install... Required: node.js. Recommended: pip, docker, docker-compose (pip install docker-compose), and a text editor (recommended: Visual Studio Code)
  • Step 3: Build
    • Recommended Method (Makefile): Use make test to run tests and make start to start server
    • Advanced Method (Without docker)
      1. Setup a mongodb server
      2. Setup environment variables (see docker-compose.yml and src/config.ts for environment variables list)
      3. Install dependencies: npm install
      4. Test: npm test
      5. Run: npm start
    • Advanced Method (With docker and docker-compose)
      1. Run database (mongodb): docker-compose up -d mongo
      2. Test: docker-compose run addon test
      3. Run: docker-compose up addon
  • Bonus Step: Install the following extensions to Visual Studio Code:
    • Abracadabra, refactor this!
    • Beautify
    • Docker
    • ESLint
    • Git History
    • GitLens — Git supercharged
    • Hocus Pocus
    • indent-rainbow
    • npm
    • npm Intellisense
    • Path Intellisense
    • Prettier - Code formatter
    • Prettify JSON
    • TSLint
    • Visual Studio IntelliCode
    • (If you're on WSL 2) WSL workspaceFolder
    • YAML
• Making Changes
  • Step 4: Create a Feature branch. It should be prefixed by feature/ (e.g. feature/new-ui)
  • Step 5a: Write tests using JavaScript and Jest.
  • Step 5b: Write source code (important: follow our Style Guides)
  • Step 6a: Run tests
  • Step 6b: Commit (english-only!)
  • Step 7: Rebase
  • Step 9: Push to your repository (usually configured as a git-remote named origin)
  • Step 10: Open the Pull Request
    • Attention: (1) select victorgveloso/MicoLeaoDubladoAPI as base repository and main as base branch. (2) compare to the created Feature branch on your repository
  • Step 11: Eventually some github actions fail and you should fix them before getting a feedback.
  • Step 12: Discuss and update patch.

Style Guides

• Use PascalCase for classes and interfaces; use camelCase for methods and attributes; use SCREAMING_SNAKE_CASE for exported constants (globally scoped constants).
• Always remmeber to run TSLint and use the command Format Document on Visual Studio Code (configured to use vscode.typescript-language-features as the default formatter)