Skip to content

Commit 5541363

Browse files
authored
Merge pull request #106 from Chrilleweb/cmn/dev
added contribution.md
2 parents d67b60c + be00b5b commit 5541363

File tree

2 files changed

+43
-1
lines changed

2 files changed

+43
-1
lines changed

CONTRIBUTING.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Contributing
2+
3+
Thanks for your interest in contributing to dotenv-diff! Contributions of all kinds are welcome — code, documentation, ideas, and feedback.
4+
5+
## Getting Started
6+
7+
1. Fork the repository
8+
2. Clone your fork
9+
3. Install dependencies: `pnpm install`
10+
4. Make your changes
11+
5. Run tests: `pnpm run test`
12+
6. Commit and push your changes
13+
7. Open a pull request
14+
15+
## Guidelines
16+
17+
**Code Quality**
18+
- Keep changes small and focused
19+
- Follow the existing code style and project structure
20+
- Write clear, descriptive commit messages
21+
22+
**Testing & Documentation**
23+
- Add or update tests when introducing new behavior
24+
- Update the README or documentation when relevant
25+
26+
**Communication**
27+
- For larger changes or new features, open an issue first to discuss
28+
- Avoid large refactors or breaking changes unless discussed beforehand
29+
30+
## Pull Requests
31+
32+
- Open your PR against the `main` branch
33+
- Describe what you changed and why
34+
- Link to related issues if applicable
35+
36+
## Questions or Ideas?
37+
38+
Feel free to open an issue for discussion — all feedback is welcome.
39+
40+
---
41+
42+
Thanks for contributing! 💚

src/commands/scanUsage.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ export async function scanUsage(
193193
* @param usages - List of environment variable usages
194194
* @returns Filtered list of environment variable usages
195195
*/
196-
function skipCommentedUsages(usages: EnvUsage[]): EnvUsage[] {
196+
function skipCommentedUsages(usages: readonly EnvUsage[]): EnvUsage[] {
197197
let insideHtmlComment = false;
198198
let insideIgnoreBlock = false;
199199

0 commit comments

Comments
 (0)