Skip to content

Conversation

@nglcobdai
Copy link
Owner

🔨 変更内容

This pull request includes various changes to improve the project setup, documentation, and workflows. The most important changes include the addition of GitHub issue templates, new workflows for code review and deployment, and updates to the Docker setup and documentation.

GitHub Issue Templates:

  • Added templates for bug reports, feature requests, specification changes, and surveys in the .github/ISSUE_TEMPLATE directory. [1] [2] [3] [4]

Workflows:

  • Added a code-review.yml workflow to automate code reviews with Python dependencies, tests, and linting.
  • Added a deploy-document.yml workflow for deploying Sphinx documentation to GitHub Pages.
  • Added a pytest.yml workflow to run tests with pytest using Docker.

Docker Setup:

  • Added a Dockerfile to set up a Python environment with Jupyter notebook and Poetry.
  • Added a docker-compose.yml to define services and environment settings for the project.

Documentation:

  • Added a LICENSE file with the MIT license.
  • Updated README.md to reflect the project as a Python template repository and added badges for license and environment.
  • Added Sphinx documentation files, including Makefile, make.bat, and reStructuredText files for API, development, installation, and quickstart guides. [1] [2] [3] [4] [5] [6]

Environment Configuration:

  • Added example environment variables in .env.example.
  • Updated .vscode/setting.json to configure Python linting and formatting settings.

💡 特筆事項

📸 スクリーンショット

✅ 解決するイシュー

🤝 関連するイシュー

@nglcobdai nglcobdai added documentation ドキュメントに関するタスク feature 実装に関するタスク labels Dec 29, 2024
@nglcobdai nglcobdai merged commit 6bef402 into main Dec 29, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation ドキュメントに関するタスク feature 実装に関するタスク

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants