Skip to content

DOC: add and clarify guidelines for referencing external code#3220

Closed
devesh-047 wants to merge 2 commits into
aeon-toolkit:mainfrom
devesh-047:docs/external-references-guidelines
Closed

DOC: add and clarify guidelines for referencing external code#3220
devesh-047 wants to merge 2 commits into
aeon-toolkit:mainfrom
devesh-047:docs/external-references-guidelines

Conversation

@devesh-047
Copy link
Copy Markdown
Contributor

This PR expands the existing contributor guidance on acknowledging external code by
adding a dedicated section that explains when attribution is required, where references
should be placed, recommended formats, and licensing considerations.

A concrete example (PR #2748) is included for clarity. The documentation builds
successfully and renders correctly.

Closes #3213.

@aeon-actions-bot aeon-actions-bot Bot added the documentation Improvements or additions to documentation label Jan 1, 2026
@aeon-actions-bot
Copy link
Copy Markdown
Contributor

Thank you for contributing to aeon

I have added the following labels to this PR based on the title: [ documentation ].

The Checks tab will show the status of our automated tests. You can click on individual test runs in the tab or "Details" in the panel below to see more information if there is a failure.

If our pre-commit code quality check fails, any trivial fixes will automatically be pushed to your PR unless it is a draft.

Don't hesitate to ask questions on the aeon Slack channel if you have any.

PR CI actions

These checkboxes will add labels to enable/disable CI functionality for this PR. This may not take effect immediately, and a new commit may be required to run the new configuration.

  • Run pre-commit checks for all files
  • Run mypy typecheck tests
  • Run all pytest tests and configurations
  • Run all notebook example tests
  • Run numba-disabled codecov tests
  • Stop automatic pre-commit fixes (always disabled for drafts)
  • Disable numba cache loading
  • Regenerate expected results for testing
  • Push an empty commit to re-run CI checks

@devesh-047
Copy link
Copy Markdown
Contributor Author

I’ve opened a PR adding explicit guidelines for referencing external code, aligned with
the example in PR #2748.

@MatthewMiddlehurst
Copy link
Copy Markdown
Member

MatthewMiddlehurst commented Jan 1, 2026

Probably a bit much for the contributor guide pages. It appears to confuse paper references with the attribution from the PR I made? Not sure if generated by an LLM

Please dont ignore the template and contributor guide.

@devesh-047 devesh-047 closed this Jan 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOC] Update contributor/developer docs to include guidance on properly referencing externally written code

2 participants