From f256e4f0d990bd5b72e3dce69a3e4085004c7388 Mon Sep 17 00:00:00 2001
From: Simeon <simkaned@gmail.com>
Date: Tue, 17 Sep 2024 10:43:54 +0300
Subject: [PATCH] added draft for contribution guidelines

---
 CONTRIBUTING.md | 57 +++++++++++++++++++++++++++++++++++++++++++++++++
 README.md       | 10 ++++-----
 2 files changed, 61 insertions(+), 6 deletions(-)
 create mode 100644 CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..ec9917d
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,57 @@
+# Contributing to JaxADi
+
+We're thrilled that you're interested in contributing to JaxADi! This document outlines the process for contributing to this project.
+
+## How to Contribute
+
+There are many ways to contribute to JaxADi:
+
+1. Reporting bugs
+2. Suggesting enhancements
+3. Writing documentation
+4. Submitting code changes
+
+### Reporting Bugs
+
+1. Check the [issue tracker](https://github.com/based-robotics/jaxadi/issues) to see if the bug has already been reported.
+2. If not, create a new issue. Provide a clear title and description, as much relevant information as possible, and a code sample or executable test case demonstrating the bug.
+
+### Suggesting Enhancements
+
+1. Check the [issue tracker](https://github.com/based-robotics/jaxadi/issues) to see if the enhancement has already been suggested.
+2. If not, create a new issue. Clearly describe the enhancement, why it would be useful, and any potential drawbacks.
+
+### Writing Documentation
+
+Good documentation is crucial. If you notice any part of our documentation that could be improved or expanded, please let us know or submit a pull request with your suggested changes.
+
+### Submitting Code Changes
+
+1. Fork the repository.
+2. Create a new branch for your changes.
+3. Make your changes in your branch.
+4. Add or update tests as necessary.
+5. Ensure the test suite passes.
+6. Update the documentation as needed.
+7. Push your branch and submit a pull request.
+
+## Pull Request Process
+
+1. Ensure your code follows the project's style guidelines.
+2. Update the README.md or relevant documentation with details of changes, if applicable.
+3. Add tests for your changes and ensure all tests pass.
+4. Your pull request will be reviewed by the maintainers. They may suggest changes or improvements.
+5. Once approved, your pull request will be merged.
+
+<!-- TODO:
+
+## Style Guidelines
+
+We use Ruff to enforce our code style and linting rules....
+```bash
+pip3 install pre-commit
+```
+```bash
+pre-commit install
+``` -->
+
diff --git a/README.md b/README.md
index 62c39ce..1875cd8 100644
--- a/README.md
+++ b/README.md
@@ -86,9 +86,9 @@ JAXADI comes with several examples to help you get started:
 
 (Consider adding a section about performance comparisons between CasADi and JAXADI-translated functions) -->
 
-<!-- ## Contributing
+## Contributing
 
-We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for more details. -->
+We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for more details.
 
 ## Citation
 
@@ -97,11 +97,9 @@ If you use JaxADi in your research, please cite it as follows:
 ```bibtex
 @misc{jaxadi2024,
   title = {JaxADi: Bridging CasADi and JAX for Efficient Numerical Computing},
-  author = {Kozlov, Lev and Alentev, Igor and Nedelchev, Simeon},
+  author = {Alentev, Igor and Kozlov, Lev and Nedelchev, Simeon},
   year = {2024},
-  publisher = {GitHub},
-  journal = {GitHub repository},
-  howpublished = {\url{https://github.com/based-robotics/jaxadi}},
+  url = {https://github.com/based-robotics/jaxadi},
   note = {Accessed: [Insert Access Date]}
 }
 ```