@@ -5,29 +5,34 @@ Thank you for your interest in contributing to Blockingmachine! This document pr
55## Development Setup
66
771 . Fork and clone the repository:
8+
89``` bash
910git clone https://github.com/yourusername/Blockingmachine.git
1011cd Blockingmachine/packages/core
1112```
1213
13142 . Install dependencies:
15+
1416``` bash
1517npm install
1618```
1719
18203 . Run tests:
21+
1922``` bash
2023npm test
2124```
2225
2326## Development Workflow
2427
25281 . Create a new branch:
29+
2630``` bash
2731git checkout -b feature/your-feature-name
2832```
2933
30342 . Make your changes and ensure:
35+
3136 - Tests pass (` npm test ` )
3237 - Code is properly formatted (` npm run format ` )
3338 - Linter is happy (` npm run lint ` )
@@ -71,6 +76,7 @@ feat: add new rule processing feature
7176- Maintain existing tests
7277- Aim for high test coverage
7378- Run tests before submitting PR:
79+
7480``` bash
7581npm test
7682```
@@ -100,7 +106,7 @@ When contributing new files, include this copyright header at the top:
100106/**
101107 * Copyright (c) 2025, Daniel Hipskind
102108 * All rights reserved.
103- *
109+ *
104110 * This source code is licensed under the BSD-3-Clause license found in the
105111 * LICENSE file in the root directory of this source tree.
106112 */
@@ -109,9 +115,10 @@ When contributing new files, include this copyright header at the top:
109115### License Compliance
110116
111117Ensure your contributions:
118+
112119- Do not include code from projects with incompatible licenses
113120- Maintain all existing copyright and license notices
114121- Include attribution for any third-party code or resources
115122- Comply with the BSD 3-Clause license terms
116123
117- For more details, see the [ LICENSE] ( LICENSE ) file in the root directory.
124+ For more details, see the [ LICENSE] ( LICENSE ) file in the root directory.
0 commit comments