version bump
Code Release Week Checklist
This checklist is intended to help reviewers evaluate code repositories during Code Release Week. Reviewers should go through each section and mark the corresponding checkboxes based on their assessment of the repository.
Quality of GitHub repository README.md file
-
[x] Is the content grammatically well-written, clear, and easily understandable?
-
[ ] Does it contain a clear statement of need that illustrates the purpose of the project?
Project Structure and Files
-
[ ] Does the project include a
src/<project_name>folder where the whole code is contained? -
[ ] Does the project include the
LICENSEfile (with contents of an OSI approved license)? -
[ ] Does the project include a
Makefilewith common targets such asbuild,test,lint, anddocs?
Code Quality
-
[ ] Is the code compliant with the Coding Fundamentals of the BRG Python Coding Style?
-
[ ] Is the code compliant with the docstring format of the BRG Python Coding Style?
-
[ ] Does the code include docstrings for all modules, functions, and classes?
-
[ ] Does the code include comments explaining non-trivial code blocks?
-
[ ] Does the code pass the Ruff check (compliance with BRG Python Coding Style)?
Documentation Quality
-
[ ] Is the content grammatically well-written, clear, and easily understandable?
-
[ ] Does it contain a clear statement of need that illustrates the purpose of the project?
-
[ ] Does it contain clear installation instructions that follow standard procedures?
-
[ ] Does it include sufficient documentation to understand the core functionality of the code?
Benchmarks, Testing, and Distribution
-
[ ] Can the code be successfully installed by following the provided instructions?
-
[ ] Does it include a simple example usage that illustrates how to use the code?
-
[ ] Does the project include a set of benchmarks that cover the core functionality of the code?
-
[ ] Can the Python package distribution be successfully built?