Extensible tools for parsing annotations in codebases
This package provides configurable and extensible tools for parsing and summarizing annotations in a wide range of codebases. Originally intended for annotating code which stores personally identifiable information (PII), these tools are optimized for that use case but can be generalized for other types of annotations.
Additionally, a logically separate part of this repository will contain specific annotation configurations and supporting tools, such as Sphinx extensions for documenting specific annotation types. See the
The full documentation is at https://code-annotations.readthedocs.org.
The code in this repository is licensed under the AGPL 3.0 unless otherwise noted.
LICENSE.txt for details.
How To Contribute
Contributions are very welcome.
Please read How To Contribute for details.
Even though they were written with
edx-platform in mind, the guidelines
should be followed for Open edX code in general.
PR description template should be automatically applied if you are sending PR from github interface; otherwise you can find it it at PULL_REQUEST_TEMPLATE.md
Issue report template should be automatically applied if you are sending it from github UI as well; otherwise you can find it at ISSUE_TEMPLATE.md
Reporting Security Issues
Please do not report security issues in public. Please email email@example.com.
Have a question about this repository, or about Open edX in general? Please refer to this list of resources if you need any assistance.