Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
67 commits
Select commit Hold shift + click to select a range
f89816b
Update aboutcode-project-overview.rst
DennisClark Jun 26, 2025
e0d08fd
Add DejaCode and PurlDB to project list
DennisClark Jun 26, 2025
8934cf9
Create getting-started/temp.rst
DennisClark Jun 26, 2025
de02680
Create new getting-started docs
DennisClark Jun 26, 2025
0ca1881
Add Makefile and instructions to build the docs locally
tdruez Jun 27, 2025
1aa4111
Issue #27 Improve Getting Started docs
DennisClark Jun 30, 2025
d711bbe
Issue #27 Improve Getting Started docs
DennisClark Jun 30, 2025
a5dd80e
Issue #27 Improve Getting Started docs
DennisClark Jun 30, 2025
db142b8
Issue #27 Improve Getting Started docs
DennisClark Jun 30, 2025
d2c0064
Issue #27 Improve Getting Started docs
DennisClark Jun 30, 2025
bf95d80
Issue #27 this file deprecated
DennisClark Jun 30, 2025
130403e
Issue #27 this file deprecated
DennisClark Jun 30, 2025
4d08023
Issue #27 this file deprecated
DennisClark Jun 30, 2025
a1b8731
Issue #27 this file deprecated
DennisClark Jun 30, 2025
141fb92
Issue #27 Refinements to Getting Started docs
DennisClark Jun 30, 2025
99fd1fb
Issue #27 remove unused files
DennisClark Jul 1, 2025
950f67b
Issue #27 minor improvement to text
DennisClark Jul 1, 2025
d28ae46
Issue #27 some reorganizing of the project list
DennisClark Jul 1, 2025
52e950b
Merge branch 'main' into improve-docs
DennisClark Jul 1, 2025
3392ba3
Issue #27 Correct formatting problems in two docs
DennisClark Jul 1, 2025
faf767b
Issue #27 Introduce start-scanning-code and additional projects
DennisClark Jul 2, 2025
add5569
Issue #27 respond to suggestions in PR #202
DennisClark Jul 7, 2025
13262f8
Issue #27. Identify additional supporting AboutCode projects.
DennisClark Jul 7, 2025
e94108c
Add GSoC 2025 Project Report
michaelehab Aug 21, 2025
5fb8713
Update GSoC 2025 report
michaelehab Aug 26, 2025
ee57758
Update RTD docs builds
AyanSinhaMahapatra Aug 26, 2025
023167e
Merge pull request #210 from aboutcode-org/fix-rtd-pages
AyanSinhaMahapatra Aug 27, 2025
d4d05d1
add gsoc25 report
alok1304 Aug 27, 2025
81212f3
Update scancode_toolkit_alok.rst
alok1304 Aug 27, 2025
be2ee66
Fix failing tests and update report
michaelehab Aug 27, 2025
64f1bd3
Merge branch 'aboutcode-org:main' into gsoc2025-report
michaelehab Aug 27, 2025
ab0eb74
updated gsoc report
alok1304 Aug 28, 2025
ebfaeb1
Add images to static folder and fix bullet points
michaelehab Aug 28, 2025
ce25ecf
Merge branch 'gsoc2025-report' of https://github.com/michaelehab/abou…
michaelehab Aug 28, 2025
b7f46c9
Add Importers Registries Diagram
michaelehab Aug 28, 2025
304910c
Add GSoC final report
aayushkdev Aug 28, 2025
485773c
initial push for gsoc report
NucleonGodX Aug 29, 2025
1ad43d8
fix tests
NucleonGodX Aug 29, 2025
bfbe7b3
Merge pull request #209 from michaelehab/gsoc2025-report
AyanSinhaMahapatra Aug 31, 2025
20aee02
Merge branch 'main' into gsoc-report-25
AyanSinhaMahapatra Aug 31, 2025
96e824d
Merge pull request #211 from alok1304/gsoc-report-25
AyanSinhaMahapatra Aug 31, 2025
21d3bef
Merge branch 'main' into gsoc-2025
AyanSinhaMahapatra Aug 31, 2025
7822225
Merge pull request #213 from NucleonGodX/gsoc-2025
AyanSinhaMahapatra Aug 31, 2025
6ff3350
Merge branch 'main' into main
AyanSinhaMahapatra Aug 31, 2025
625954a
Merge pull request #212 from aayushkdev/main
AyanSinhaMahapatra Aug 31, 2025
e1a57e2
fix failing test cases in GSoC final report
aayushkdev Sep 1, 2025
9bd7f14
Merge pull request #214 from aayushkdev/main
AyanSinhaMahapatra Sep 1, 2025
dc6a35f
Add GSoC 2025 report
VarshaUN Sep 26, 2025
20a26a3
fix CI issues
VarshaUN Sep 28, 2025
f9ad372
Merge pull request #216 from VarshaUN/gsoc2025-report
AyanSinhaMahapatra Sep 28, 2025
f8242cb
Merge pull request #222 from aboutcode-org/new-readme
DennisClark Dec 15, 2025
518cf1f
Merge pull request #202 from aboutcode-org/improve-docs
DennisClark Jan 5, 2026
b4c372b
Restructure README.md and add CONTRIBUTING.md #251
Jan 28, 2026
4ba4bc6
Merge pull request #252 from gyanranjanpanda/restructure-readme-251
DennisClark Jan 28, 2026
6a9aafc
Fix sidebar home button link (Issue #248)
Jan 29, 2026
a23ba52
Merge pull request #253 from gyanranjanpanda/fix/home-button-link
DennisClark Feb 3, 2026
eab1fdb
Update github_user to aboutcode-org in docs config
Feb 4, 2026
6d517a1
Merge pull request #256 from gyanranjanpanda/fix/github-org-link
DennisClark Feb 4, 2026
9d97cd9
docs: fix critical UI issues in documentation
Feb 4, 2026
c80acde
Merge pull request #259 from gyanranjanpanda/docs/minimal-ui-fixes
DennisClark Feb 4, 2026
b907948
docs: remove broken logo link from GSoC 2017 page
Feb 5, 2026
eed7786
docs: add AboutCode logo to GSoC 2017 page
Feb 5, 2026
1a62010
Merge pull request #261 from gyanranjanpanda/fix/broken-logo-gsoc-2017
DennisClark Feb 5, 2026
0f78fb7
fix: improve UI padding and text alignment between navbar and content
Feb 5, 2026
038de98
fix: rename license file for GitHub recognition
Feb 5, 2026
79c8699
Merge pull request #262 from gyanranjanpanda/fix/ui-padding-navbar-sp…
DennisClark Feb 11, 2026
18c859f
Merge pull request #263 from gyanranjanpanda/fix/license-file-recogni…
DennisClark Feb 16, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 3 additions & 10 deletions .github/workflows/docs-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ jobs:
strategy:
max-parallel: 4
matrix:
python-version: [3.9]
python-version: [3.13]

steps:
- name: Checkout code
Expand All @@ -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
4 changes: 2 additions & 2 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
91 changes: 91 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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.
File renamed without changes.
22 changes: 22 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -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
Loading