This repository serves as a standardized template for organizing and conducting Python-based research projects. It's optimized for ensuring code quality and facilitating collaboration.
This template is designed for academic research purposes during my master's and Ph.D. journey.
├── data/ # Raw and processed data
├── .github/
│ ├── PULL_REQUEST_TEMPLATE.md # Template for pull requests
│ └── workflows/
│ └── ruff.yml # Workflow for Ruff linting on push and pull requests
├── .gitignore # List of files and directories to ignore in git
├── LICENSE # Licensing details
├── logs/ # Logs for debugging and performance checks
├── models/ # Trained machine learning models and their metadata
├── notebooks/ # Jupyter notebooks
├── src/ # source codes
├── requirements.txt # pip library version management
├── pyproject.toml # Project configurations and settings
└── README.md # Project documentation
- The project enforces linting rules using Ruff, with specific rules outlined in
pyproject.toml
. - When submitting code, please ensure that it adheres to these standards.
- Clone the repository.
- Create a new branch.
- Make your changes.
- Ensure your code adheres to the coding standards mentioned above.
- Open a pull request, using the template provided in
.github/PULL_REQUEST_TEMPLATE.md
.
- [title]
- [publication date]
- [url]
This project is licensed under the terms of the MIT License.