Update readme doc

.github/workflows/docs-ci.yml

@@ -9,7 +9,7 @@ jobs:
     strategy:
       max-parallel: 4
       matrix:
-        python-version: [3.9]
+        python-version: [3.13]
 
     steps:
       - name: Checkout code
@@ -20,15 +20,8 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
 
-      - name: Install Dependencies
-        run:  pip install -e .[docs]
-
       - name: Check Sphinx Documentation build minimally
-        working-directory: ./docs
-        run: sphinx-build -E -W source build
+        run: make docs
 
       - name: Check for documentation style errors
-        working-directory: ./docs
-        run: ./scripts/doc8_style_check.sh
-
-
+        run: make check

.readthedocs.yml

@@ -7,9 +7,9 @@ version: 2
 
 # Build in latest ubuntu/python
 build:
-  os: ubuntu-22.04
+  os: ubuntu-24.04
   tools:
-    python: "3.11"
+    python: "3.13"
 
 # Build PDF & ePub
 formats:

CONTRIBUTING.md

@@ -0,0 +1,91 @@
+# Contributing to AboutCode
+
+Welcome! We're excited that you're interested in contributing to AboutCode. This document will help you get started with contributing to our projects.
+
+## Quick Start for New Contributors
+
+1. **Explore Our Projects**: Browse through our [project list](README.md#projects) to find something that interests you
+2. **Find an Issue**: Look for issues labeled `good first issue` or `help wanted` in the repository you're interested in
+3. **Join the Community**: Introduce yourself in our [Gitter chat](https://app.gitter.im/#/room/#aboutcode-org_discuss:gitter.im) or on [Slack](https://join.slack.com/t/aboutcode-org/shared_invite/zt-1paqwxccw-IuafuiAvYJFkTqGaZsC1og)
+4. **Read the Documentation**: Check out our [full documentation](https://aboutcode.readthedocs.io/en/latest/) for detailed guides
+
+## Communication Channels
+
+- **Gitter Chat**: [aboutcode-org#discuss](https://app.gitter.im/#/room/#aboutcode-org_discuss:gitter.im)
+- **Slack**: [Join our workspace](https://join.slack.com/t/aboutcode-org/shared_invite/zt-1paqwxccw-IuafuiAvYJFkTqGaZsC1og)
+- **Weekly Meetings**: We hold weekly community calls. See [meeting minutes](https://github.com/aboutcode-org/aboutcode/wiki/MeetingMinutes) for details
+
+## How to Contribute
+
+### Reporting Issues
+
+If you find a bug or have a feature request:
+- Check if the issue already exists
+- If not, create a new issue with a clear title and description
+- Include steps to reproduce (for bugs) or use cases (for features)
+
+### Contributing Code
+
+1. **Fork the repository** you want to contribute to
+2. **Create a branch** for your changes: `git checkout -b fix-issue-123`
+3. **Make your changes** following the project's coding standards
+4. **Write tests** if applicable
+5. **Commit your changes** with a clear commit message (see our [commit message guidelines](https://aboutcode.readthedocs.io/en/latest/contributing/writing_good_commit_messages.html))
+6. **Push to your fork** and submit a pull request
+
+### Contributing Documentation
+
+Documentation improvements are always welcome! You can:
+- Fix typos or clarify existing documentation
+- Add examples or tutorials
+- Improve the structure and organization
+
+Documentation is built using Sphinx. To build locally:
+```bash
+make docs
+```
+
+## Development Guidelines
+
+### Commit Messages
+
+We follow specific commit message conventions:
+- Use imperative mood ("Add feature" not "Added feature")
+- Keep the subject line under 50 characters
+- Reference issue numbers when applicable (#123)
+- Sign off your commits with `Signed-off-by: Your Name <your.email@example.com>`
+
+For detailed guidelines, see our [commit message documentation](https://aboutcode.readthedocs.io/en/latest/contributing/writing_good_commit_messages.html).
+
+### Testing
+
+Before submitting a pull request:
+- Run existing tests to ensure nothing breaks
+- Add new tests for new functionality
+- Ensure all tests pass
+
+See the [testing documentation](https://aboutcode.readthedocs.io/en/latest/contributing/testing.html) for more details.
+
+## Code of Conduct
+
+We are committed to providing a welcoming and inclusive environment. Please read our [Code of Conduct](CODE_OF_CONDUCT.rst) before participating.
+
+## Getting Help
+
+- **Documentation**: Start with our [ReadTheDocs](https://aboutcode.readthedocs.io/en/latest/)
+- **Chat**: Ask questions on [Gitter](https://app.gitter.im/#/room/#aboutcode-org_discuss:gitter.im) or [Slack](https://join.slack.com/t/aboutcode-org/shared_invite/zt-1paqwxccw-IuafuiAvYJFkTqGaZsC1og)
+- **Issues**: Open an issue in the relevant repository if you need help with something specific
+
+## Additional Resources
+
+- [Full Contributing Guide](https://aboutcode.readthedocs.io/en/latest/contributing.html)
+- [Documentation Contribution Guide](https://aboutcode.readthedocs.io/en/latest/contributing/contrib_doc.html)
+- [GSoC Information](https://github.com/aboutcode-org/aboutcode/wiki)
+
+## License
+
+By contributing to AboutCode, you agree that your contributions will be licensed under the Apache License 2.0.
+
+---
+
+Thank you for contributing to AboutCode! Your efforts help make open source software safer and more transparent for everyone.

Makefile

@@ -0,0 +1,22 @@
+# Python version can be specified with `$ PYTHON_EXE=python3.x make ...`
+PYTHON_EXE?=python3
+VENV_LOCATION=venv
+ACTIVATE?=. ${VENV_LOCATION}/bin/activate;
+
+conf:
+	@echo "-> Install dependencies"
+	./configure --docs
+
+docs: conf
+	rm -rf docs/build/
+	@${ACTIVATE} sphinx-build  -E -W docs/source docs/build/
+
+check:
+	@${ACTIVATE} doc8 --max-line-length 100 docs/source/ --ignore D000 --quiet
+
+clean:
+	@echo "-> Clean the Python env"
+	rm -rf .venv/ .*cache/ *.egg-info/ build/ dist/
+	find . -type f -name '*.py[co]' -delete -o -type d -name __pycache__ -delete
+
+.PHONY: conf docs clean