docs(ai): update quickstart and contributing (agent)

This commit is contained in:
google-labs-jules[bot] committed 2026-01-25 14:26:24 +00:00
1 parent 7afe811b1f
commit 726ef24e4d
2 files changed
+16 -29

No files matched your search

+10 -3
View File
@@ -45,10 +45,11 @@ Automated agents contributing to this repository should follow these rules:
1. Fork the repository and create a new branch from `main`.
2. Make your changes, adding tests if applicable.
3. Run `npm run test:unit` and `npm run lint` to ensure quality.
3. Run `npm run format`, `npm run test:unit`, and `npm run lint` to ensure quality.
4. (Optional) Run `npm run test:visual` if you made UI changes.
5. Push your branch and open a Pull Request against the `main` branch.
5. Provide a clear description of the problem and solution.
5. (Optional) Run domain-specific tests if relevant (e.g., `npm run test:dm:unit` for Direct Messages).
6. Push your branch and open a Pull Request against the `main` branch.
7. Provide a clear description of the problem and solution.
## CI Behavior and Operations
@@ -112,6 +113,12 @@ To set up the project locally:
npm run test:visual
```
For Direct Message features, run:
```bash
npm run test:dm:unit
npm run test:dm:integration
```
4. **Format & Lint**:
```bash
npm run format
+6 -26
View File
@@ -437,33 +437,13 @@ placeholder at “—” and development builds log a warning—so mixed deploym
### How to Contribute
1. **Fork and Clone**:
```bash
git clone https://github.com/PR0M3TH3AN/bitvid.git
cd bitvid
```
2. **Create a Branch**:
```bash
git checkout -b feature/your-feature-name
```
3. **Install Dependencies**:
```bash
npm ci
```
4. **Make Changes**:
- Ensure your code follows best practices and is well-documented.
5. **Test**:
- Run unit tests: `npm run test:unit` (or a shard like `npm run test:unit:shard1`)
- Validate the site functionality locally before submitting.
6. **Submit a Pull Request**:
- Explain your changes and reference any related issues.
Please see [`CONTRIBUTING.md`](./CONTRIBUTING.md) for detailed setup instructions, code guidelines, and agent PR conventions.
### Contribution Guidelines
- Follow the [GPL-3.0-or-later License](LICENSE).
- Use clear, concise commit messages.
- Respect the existing coding style and architecture.
- Run the manual QA script (see below) and note results in PR descriptions for changes that affect upload or playback.
1. **Fork and Clone** the repository.
2. **Create a Branch** for your feature or fix.
3. **Install Dependencies** with `npm ci`.
4. **Make Changes** and ensure tests pass.
5. **Submit a Pull Request** with a clear description.
---