chore: add contributing guide and acknowledgements to readme

Author: jvllmr

.pre-commit-config.yaml

@@ -8,11 +8,14 @@ repos:
     hooks:
       - id: cargo-fix
       - id: cargo-fmt
+  - repo: https://github.com/jvllmr/pre-commit-prettier
+    rev: v3.4.2
+    hooks:
+      - id: prettier
   - repo: https://github.com/astral-sh/ruff-pre-commit
     rev: "v0.8.4"
     hooks:
       - id: ruff
         args:
           - --fix
       - id: ruff-format
-      

CONTRIBUTING.md

@@ -0,0 +1,3 @@
+# Contributing to rustpython-unparser
+
+See [README](https://github.com/jvllmr/rustpython-unparser#contributing)

README.md

@@ -1,10 +1,16 @@
 # rustpython-unparser
 
-> [!IMPORTANT]
-> rustpython-unparser is in early development and WIP.
-
 A complete unparser for rustpython-parser ASTs.
 
+## Acknowledgement
+
+I created this library because I quickly needed a way to turn rustpython-parser ASTs back to some form of Python source code. Since the unparser contained within rustpython-ast only supports expressions and not statements, I started implementing my own unparser by taking heavy inspiration from rustpython's unparser and the unparser in the python standard library. Therefore, most of credit goes to the teams behind the ast standard library module and the RustPython team. I only glued the parts I needed together to a complete unparser in this repository.
+
+## Contributing
+
+You can already help a lot by reporting issues with generated code. If you find an issue,please provide example code of the original source and the unparsed source with a concise explanation.
+
+If you would like to fix the issue yourself, you can create an example in one of the matching files in `test_files` or create a new file with your example if you think your example does not fit into any of the existing files. Then you can run the tests with `cargo t` and verify your changes by viewing your unparse example in the `test_files_unparsed` directory. After verifying your changes you can create a Pull Request. If your change is linked to a GitHub issue, please provide a comment in the form of `# <link to github issue>` next to your example.
 
 ## Simple usage example
 
@@ -23,7 +29,4 @@ fn main() {
     let new_source = unparser.source;
     // ...
 }
-
-
-
-```
+```