mirror of
https://github.com/Stremio/stremio-web.git
synced 2026-01-11 22:40:31 +00:00
Merge aadd265ec2 into a35f7e7878
This commit is contained in:
commit
03c6894bd2
3 changed files with 150 additions and 0 deletions
38
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
38
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
|
|
@ -0,0 +1,38 @@
|
|||
---
|
||||
name: Bug Report
|
||||
about: Create a report to help us improve
|
||||
title: 'bug: '
|
||||
labels: 'bug, needs-triage'
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
**Describe the bug**
|
||||
A clear and concise description of what the bug is.
|
||||
|
||||
**To Reproduce**
|
||||
Steps to reproduce the behavior:
|
||||
1. Go to '...'
|
||||
2. Click on '....'
|
||||
3. Scroll down to '....'
|
||||
4. See error
|
||||
|
||||
**Expected behavior**
|
||||
A clear and concise description of what you expected to happen.
|
||||
|
||||
**Screenshots**
|
||||
If applicable, add screenshots to help explain your problem.
|
||||
|
||||
**Desktop (please complete the following information):**
|
||||
- OS: [e.g. iOS]
|
||||
- Browser [e.g. chrome, safari]
|
||||
- Version [e.g. 22]
|
||||
|
||||
**Smartphone (please complete the following information):**
|
||||
- Device: [e.g. iPhone6]
|
||||
- OS: [e.g. iOS8.1]
|
||||
- Browser [e.g. stock browser, safari]
|
||||
- Version [e.g. 22]
|
||||
|
||||
**Additional context**
|
||||
Add any other context about the problem here.
|
||||
20
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
20
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
|
|
@ -0,0 +1,20 @@
|
|||
---
|
||||
name: Feature Request
|
||||
about: Suggest an idea for this project
|
||||
title: 'feat: '
|
||||
labels: 'enhancement, needs-triage'
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
**Is your feature request related to a problem? Please describe.**
|
||||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
||||
|
||||
**Describe the solution you'd like**
|
||||
A clear and concise description of what you want to happen.
|
||||
|
||||
**Describe alternatives you've considered**
|
||||
A clear and concise description of any alternative solutions or features you've considered.
|
||||
|
||||
**Additional context**
|
||||
Add any other context or screenshots about the feature request here.
|
||||
92
CONTRIBUTING.md
Normal file
92
CONTRIBUTING.md
Normal file
|
|
@ -0,0 +1,92 @@
|
|||
# Contributing to Stremio Web
|
||||
|
||||
First off, thank you for considering contributing to Stremio Web! It's people like you that make Stremio Web such a great app.
|
||||
|
||||
Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- **Node.js:** This project uses a specific version of Node.js. Please use a version manager like `nvm` to ensure you are using the correct version.
|
||||
```sh
|
||||
nvm use
|
||||
```
|
||||
- **pnpm:** This project uses `pnpm` as its package manager. Please do not use `npm` or `yarn`. You can install `pnpm` with:
|
||||
```sh
|
||||
npm install -g pnpm
|
||||
```
|
||||
|
||||
### Installation
|
||||
|
||||
1. **Fork the repository:** Fork the project to your own GitHub account.
|
||||
2. **Clone your fork:**
|
||||
```sh
|
||||
git clone https://github.com/YOUR_USERNAME/stremio-web.git
|
||||
```
|
||||
3. **Navigate to the project directory:**
|
||||
```sh
|
||||
cd stremio-web
|
||||
```
|
||||
4. **Install dependencies:**
|
||||
```sh
|
||||
pnpm install
|
||||
```
|
||||
5. **Run the development server:**
|
||||
```sh
|
||||
pnpm start
|
||||
```
|
||||
|
||||
## Code Style & Linting
|
||||
|
||||
To ensure code consistency, we use **ESLint**. Before submitting a pull request, please make sure your code adheres to the project's linting rules.
|
||||
|
||||
You can run the linter with the following command:
|
||||
|
||||
```sh
|
||||
pnpm run lint
|
||||
```
|
||||
|
||||
Any pull request with linting errors will not be merged.
|
||||
|
||||
## Branching & Pull Request Process
|
||||
|
||||
We have a structured process for submitting pull requests to ensure a clear and organized workflow.
|
||||
|
||||
**All pull requests must target the `development` branch.**
|
||||
|
||||
### Branch Naming Convention
|
||||
|
||||
Your branch name should follow this convention:
|
||||
|
||||
- `feature/<brief-description>` for new features (e.g., `feature/add-skip-intro-button`)
|
||||
- `fix/<issue-number-or-bug>` for bug fixes (e.g., `fix/123-library-loading-bug`)
|
||||
- `chore/<housekeeping-task>` for maintenance tasks (e.g., `chore/update-dependencies`)
|
||||
|
||||
### Pull Request Titles
|
||||
|
||||
PR titles must follow the **Conventional Commits** specification. This helps us automate changelogs and clearly document changes.
|
||||
|
||||
Examples:
|
||||
- `feat: Add user profile page`
|
||||
- `fix: Resolve issue with video player crashing`
|
||||
- `docs: Update CONTRIBUTING.md guide`
|
||||
- `chore: Refactor state management module`
|
||||
|
||||
### Pull Request Descriptions
|
||||
|
||||
Your PR description **must** link to the issue it resolves. Use keywords like `Closes` or `Fixes` to automatically close the corresponding issue when the PR is merged.
|
||||
|
||||
Example:
|
||||
```
|
||||
This PR introduces a new settings panel for subtitles.
|
||||
|
||||
Closes #456
|
||||
```
|
||||
|
||||
## Issue Reporting
|
||||
|
||||
- **Bug Reports:** Please use the "Bug Report" template when creating a new issue.
|
||||
- **Feature Requests:** For new ideas, please use the "Feature Request" template.
|
||||
|
||||
Thank you for your contribution!
|
||||
Loading…
Reference in a new issue