Spaces:
Sleeping
Sleeping
|
Download .github/CONTRIBUTING.md from dangkhoa2016/Nodejs-JSON-API-Server: direct link, hf CLI and curl.
- Browser
- Download file 1.01 kB
-
https://huggingface.co/spaces/dangkhoa2016/Nodejs-JSON-API-Server/resolve/42e30c2fc13d198cc76d79446c2a4308bbca4162/.github/CONTRIBUTING.md
- Command line
-
hf download hf://spaces/dangkhoa2016/Nodejs-JSON-API-Server@42e30c2fc13d198cc76d79446c2a4308bbca4162/.github/CONTRIBUTING.md
-
curl -L -o CONTRIBUTING.md https://huggingface.co/spaces/dangkhoa2016/Nodejs-JSON-API-Server/resolve/42e30c2fc13d198cc76d79446c2a4308bbca4162/.github/CONTRIBUTING.md
1.01 kB
| # Contributing | |
| Thank you for considering contributing to this project. | |
| ## Development Setup | |
| ```bash | |
| git clone https://github.com/dangkhoa2016/NodeJs-JSON-API-Server.git | |
| cd NodeJs-JSON-API-Server | |
| yarn install | |
| ``` | |
| ## Setting up the database | |
| ```bash | |
| yarn db:setup # migrate + seed (required before first start) | |
| ``` | |
| ## Running Tests | |
| ```bash | |
| yarn test # run all tests once | |
| yarn test:watch # watch mode | |
| yarn test:coverage # run with V8 coverage report | |
| ``` | |
| ## Code Style | |
| - Prefer Node.js built-ins over third-party dependencies where possible | |
| - Keep functions focused and small | |
| - Follow the existing patterns in `src/` and `tests/` | |
| ## Pull Request Process | |
| 1. Fork the repo and create a branch from `main` | |
| 2. Add tests for any new functionality | |
| 3. Ensure all tests pass (`yarn test`) | |
| 4. Update documentation if needed | |
| 5. Submit a pull request with a clear description | |
| ## Reporting Bugs | |
| Open an issue with: | |
| - Steps to reproduce | |
| - Expected vs actual behavior | |
| - Node.js version and OS | |