docs(CONTRIBUTING): simplify contribution steps and remove redundant test process
- Updated `README.md` and `CONTRIBUTING.md` to streamline contribution instructions. - Removed references to running tests (`npm test`) as part of the contribution process to reduce complexity for contributors. - Adjusted steps to focus on creating feature branches, using conventional commit messages, and submitting pull requests. - Simplified `package.json` by removing unused devDependencies (`jest`, `@types/jest`, `ts-jest`) to reflect the updated process.
This commit is contained in:
parent
23e84e43ce
commit
ff28ffffe7
3 changed files with 3 additions and 10 deletions
|
|
@ -32,7 +32,6 @@ Update API documentation
|
|||
Add support for IndexedDB storage
|
||||
Change API parameter order
|
||||
Simplify vector comparison logic
|
||||
Add tests for metadata filtering
|
||||
Update build dependencies
|
||||
```
|
||||
|
||||
|
|
@ -40,16 +39,14 @@ Update build dependencies
|
|||
|
||||
1. Ensure your code follows the project's coding standards
|
||||
2. Update the documentation if necessary
|
||||
3. Make sure all tests pass
|
||||
4. Use conventional commit messages in your PR
|
||||
5. Your PR will be reviewed by maintainers and merged if approved
|
||||
3. Use conventional commit messages in your PR
|
||||
4. Your PR will be reviewed by maintainers and merged if approved
|
||||
|
||||
## Development Setup
|
||||
|
||||
1. Fork and clone the repository
|
||||
2. Install dependencies: `npm install`
|
||||
3. Build the project: `npm run build`
|
||||
4. Run tests: `npm test`
|
||||
|
||||
## Code Style
|
||||
|
||||
|
|
|
|||
|
|
@ -1267,8 +1267,7 @@ Brainy follows a specific code style to maintain consistency throughout the code
|
|||
1. Fork the repository
|
||||
2. Create a feature branch
|
||||
3. Make your changes
|
||||
4. Run tests with `npm test`
|
||||
5. Submit a pull request
|
||||
4. Submit a pull request
|
||||
|
||||
## License
|
||||
|
||||
|
|
|
|||
|
|
@ -85,17 +85,14 @@
|
|||
"@rollup/plugin-node-resolve": "^15.2.3",
|
||||
"@rollup/plugin-replace": "^5.0.5",
|
||||
"@rollup/plugin-typescript": "^11.1.6",
|
||||
"@types/jest": "^29.5.3",
|
||||
"@types/node": "^20.4.5",
|
||||
"@types/omelette": "^0.4.5",
|
||||
"@types/uuid": "^10.0.0",
|
||||
"@typescript-eslint/eslint-plugin": "^6.0.0",
|
||||
"@typescript-eslint/parser": "^6.0.0",
|
||||
"eslint": "^8.45.0",
|
||||
"jest": "^29.6.2",
|
||||
"rollup": "^4.12.0",
|
||||
"rollup-plugin-terser": "^7.0.2",
|
||||
"ts-jest": "^29.1.1",
|
||||
"tslib": "^2.8.1",
|
||||
"typescript": "^5.1.6"
|
||||
},
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue