docs: add contributing doc

mcarvin8 · Feb 4, 2025 · d519452 · d519452
1 parent d132184
commit d519452
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,32 @@
+# Contributing
+
+Contributions are welcome! If you would like to contribute, please fork the repository, make your changes, and submit a pull request.
+
+## Requirements
+
+- pnpm >= 8
+- node >= 18
+
+## Installation
+
+### 1) Fork the repository
+
+### 2) Install Dependencies
+
+This will install all the tools needed to contribute
+
+```bash
+pnpm install
+```
+
+## Testing
+
+When developing, run the provided tests for new additions.
+
+```bash
+pnpm test
+```
+
+## Core Package
+
+This package is an extension of the core [xml-disassembler](https://github.com/mcarvin8/xml2-disassembler). For core XML disassembly/reassembly issues, please fork and raise PRs in that repo. Ensure this package is updated to use the latest xml-disassembler.
diff --git a/README.md b/README.md
@@ -15,6 +15,7 @@ A JavaScript package to disassemble then transform XML files into smaller JSON f
   - [JSON2XML](#json2xml)
 - [Ignore File](#ignore-file)
 - [Logging](#logging)
+- [Contributing](#contributing)
 - [Template](#template)
 </details>
 
@@ -214,6 +215,10 @@ await reassembleHandler.reassemble({
 });
 ```
 
+## Contributing
+
+Contributions are welcome! See [Contributing](https://github.com/mcarvin8/xml2json-disassembler/blob/main/CONTRIBUTING.md).
+
 ## Template
 
 This project was created from a template provided by [Allan Oricil](https://github.com/AllanOricil).