Merge pull request #113 from jmrivas86/dev

Update tests and docs

Author: erfan-rfmhr

CONTRIBUTING.md

@@ -0,0 +1,83 @@
+# Contributing
+
+Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
+
+You can contribute in many ways:
+
+## Types of Contributions
+
+### Report Bugs
+
+Report bugs at https://github.com/jmrivas86/django-json-widget/issues.
+
+If you are reporting a bug, please include:
+
+* Your operating system name and version.
+* Any details about your local setup that might be helpful in troubleshooting.
+* Detailed steps to reproduce the bug.
+
+### Fix Bugs
+
+Look through the GitHub issues for bugs. Anything tagged with "bug" is open to whoever wants to implement it.
+
+### Implement Features
+
+Look through the GitHub issues for features. Anything tagged with "feature" is open to whoever wants to implement it.
+
+### Write Documentation
+
+django-json-widget could always use more documentation, whether as part of the official django-json-widget docs, in docstrings, or even on the web in blog posts, articles, and such.
+
+### Submit Feedback
+
+The best way to send feedback is to file an issue at https://github.com/jmrivas86/django-json-widget/issues.
+
+If you are proposing a feature:
+
+* Explain in detail how it would work.
+* Keep the scope as narrow as possible, to make it easier to implement.
+* Remember that this is a volunteer-driven project, and that contributions are welcome :)
+
+## Get Started!
+
+Ready to contribute? Here's how to set up `django-json-widget` for local development.
+
+1. Fork the `django-json-widget` repo on GitHub.
+
+2. Clone your fork locally:
+   ```bash
+   git clone [email protected]:your_name_here/django-json-widget.git
+   ```
+
+3. Install development dependencies:
+   ```bash
+   cd django-json-widget/
+   python -m venv .venv
+   source .venv/bin/activate
+   pip install -r requirements_test.txt
+   ```
+
+4. Create a branch for local development from the dev branch:
+   ```bash
+   git checkout dev
+   git checkout -b name-of-your-branch
+   ```
+
+   Now you can make your changes locally.
+
+5. Commit your changes and push your branch:
+   ```bash
+   git add .
+   git commit -m "Your detailed description of your changes."
+   git push origin name-of-your-branch
+   ```
+
+6. Submit a pull request through the GitHub website.
+
+## Pull Request Guidelines
+
+Before you submit a pull request, check that it meets these guidelines:
+
+1. **The pull request must be submitted against the `dev` branch.**
+2. Please explain what you have done in the pull request.
+3. Make sure you have had passed pre-commit hooks.

CONTRIBUTING.rst

@@ -1,6 +1,6 @@
 include AUTHORS.rst
 include CONTRIBUTING.rst
-include CHANGELOG.rst
+include CHANGELOG.md
 include LICENSE
 include README.rst
 recursive-include django_json_widget *.html *.png *.gif *js *.css *jpg *jpeg *svg *py

MANIFEST.in

@@ -93,6 +93,92 @@ After:
 .. image:: https://raw.githubusercontent.com/jmrivas86/django-json-widget/master/imgs/jsonfield_1.png
 
 
+Development Guide
+-----------------
+
+This section provides instructions for setting up a development environment and contributing to django-json-widget.
+
+Setting up Development Environment
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+1. **Clone the repository**::
+
+    git clone https://github.com/jmrivas86/django-json-widget.git
+    cd django-json-widget
+
+2. **Create a virtual environment** (recommended)::
+
+    python -m venv venv
+    source venv/bin/activate  # On Windows: venv\Scripts\activate
+
+3. **Install development dependencies**::
+
+    pip install -r requirements_dev.txt
+
+4. **Install test dependencies**::
+
+    pip install -r requirements_test.txt
+
+5. **Install the package in development mode**::
+
+    pip install -e .
+
+Running Tests
+~~~~~~~~~~~~~
+
+The project includes several ways to run tests:
+
+**Using the runtests.py script** (recommended)::
+
+    python runtests.py
+
+This will run all tests using Django's test runner with the test settings.
+
+**Using tox for multiple environments**::
+
+    tox
+
+This will run tests against multiple Python and Django version combinations as defined in ``tox.ini``.
+
+**With coverage reporting**::
+
+    coverage run --source django_json_widget runtests.py
+    coverage report
+    coverage html  # Generates HTML coverage report
+
+Test Structure
+~~~~~~~~~~~~~~
+
+The test suite is organized as follows:
+
+* ``tests/test_widgets.py`` - Core widget functionality tests
+* ``tests/test_widget_security.py`` - Security-focused tests
+* ``tests/settings.py`` - Test-specific Django settings
+
+The tests cover:
+
+* Widget initialization and configuration
+* Media file handling (CSS/JS)
+* Template rendering and context generation
+* Form integration
+* Security aspects (XSS prevention, safe JSON handling)
+* Performance with large datasets
+* Edge cases and error handling
+
+Code Quality
+~~~~~~~~~~~~
+
+**Run linting with auto-fix**::
+
+    ruff check --fix
+
+**Check test coverage**::
+
+    coverage run --source django_json_widget runtests.py
+    coverage report --show-missing
+
+Aim for maintaining or improving test coverage.
+
 Credits
 -------