From b0ed0e4003f9f3a8b899a75378e824860644a504 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Sat, 11 Jul 2026 20:06:43 +0000 Subject: [PATCH 1/2] Initial plan From 125cab31c79689cc6c435a7fdb274d3620783b7a Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Sat, 11 Jul 2026 20:08:46 +0000 Subject: [PATCH 2/2] Add basic template repository structure --- .github/ISSUE_TEMPLATE/bug_report.md | 39 ++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 27 +++++++++ .github/PULL_REQUEST_TEMPLATE.md | 30 ++++++++++ .github/workflows/ci.yml | 38 ++++++++++++ CODE_OF_CONDUCT.md | 73 +++++++++++++++++++++++ CONTRIBUTING.md | 70 ++++++++++++++++++++++ README.md | 52 +++++++++++++++- 7 files changed, 328 insertions(+), 1 deletion(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 .github/workflows/ci.yml create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..f4d61f4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,39 @@ +--- +name: Bug Report +about: Report a bug to help us improve +title: "[BUG] " +labels: bug +assignees: '' +--- + +## Description + +A clear and concise description of the bug. + +## Steps to Reproduce + +1. Go to '...' +2. Run '...' +3. See error + +## Expected Behavior + +A clear and concise description of what you expected to happen. + +## Actual Behavior + +A clear and concise description of what actually happened. + +## Screenshots or Logs + +If applicable, add screenshots or log output to help explain your problem. + +## Environment + +- OS: [e.g. Ubuntu 22.04, macOS 14, Windows 11] +- Python version: [e.g. 3.11] +- Project version: [e.g. 1.0.0] + +## Additional Context + +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..6976fb3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,27 @@ +--- +name: Feature Request +about: Suggest an idea or enhancement for this project +title: "[FEATURE] " +labels: enhancement +assignees: '' +--- + +## Summary + +A clear and concise description of the feature you are requesting. + +## Motivation + +Explain why this feature would be useful. What problem does it solve? + +## Proposed Solution + +Describe the solution you'd like to see. Include any relevant details or examples. + +## Alternatives Considered + +Describe any alternative solutions or features you have considered. + +## Additional Context + +Add any other context, screenshots, or references related to the feature request here. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..cc625b3 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,30 @@ +## Description + +Please include a summary of the changes and the related issue. Include relevant motivation and context. + +Fixes # (issue) + +## Type of Change + +- [ ] Bug fix (non-breaking change that fixes an issue) +- [ ] New feature (non-breaking change that adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] Documentation update + +## How Has This Been Tested? + +Please describe the tests that you ran to verify your changes. Provide instructions so reviewers can reproduce. + +- [ ] Unit tests +- [ ] Integration tests +- [ ] Manual testing + +## Checklist + +- [ ] My code follows the style guidelines of this project +- [ ] I have performed a self-review of my code +- [ ] I have commented my code where necessary +- [ ] I have updated the documentation accordingly +- [ ] My changes generate no new warnings +- [ ] I have added tests that prove my fix or feature works +- [ ] All new and existing tests pass diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..eea5056 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,38 @@ +name: CI + +on: + push: + branches: [ "main" ] + pull_request: + branches: [ "main" ] + +jobs: + build: + runs-on: ubuntu-latest + strategy: + matrix: + python-version: ["3.9", "3.10", "3.11", "3.12"] + + steps: + - uses: actions/checkout@v4 + + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v5 + with: + python-version: ${{ matrix.python-version }} + + - name: Install dependencies + run: | + python -m pip install --upgrade pip + if [ -f requirements.txt ]; then pip install -r requirements.txt; fi + if [ -f requirements-dev.txt ]; then pip install -r requirements-dev.txt; fi + + - name: Lint with ruff + run: | + pip install ruff + ruff check . + + - name: Run tests + run: | + pip install pytest + pytest diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..a594257 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,73 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our community include: + +- Demonstrating empathy and kindness toward other people +- Being respectful of differing opinions, viewpoints, and experiences +- Giving and gracefully accepting constructive feedback +- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience +- Focusing on what is best not just for us as individuals, but for the overall community + +Examples of unacceptable behavior include: + +- The use of sexualized language or imagery, and sexual attention or advances of any kind +- Trolling, insulting or derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or email address, without their explicit permission +- Other conduct which could reasonably be considered inappropriate in a professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official email address, posting via an official social media account, or acting as an appointed representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement. All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of actions. + +**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1, available at . diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..d619935 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,70 @@ +# Contributing + +Thank you for your interest in contributing to this project! Here are some guidelines to help you get started. + +## Code of Conduct + +Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md) to keep our community welcoming and respectful. + +## How to Contribute + +### Reporting Bugs + +If you find a bug, please open an issue using the [bug report template](.github/ISSUE_TEMPLATE/bug_report.md) and include as much detail as possible. + +### Suggesting Features + +Have an idea for a new feature? Open an issue using the [feature request template](.github/ISSUE_TEMPLATE/feature_request.md) and describe your suggestion. + +### Submitting Pull Requests + +1. Fork the repository and create your branch from `main`: + + ```bash + git checkout -b feature/your-feature-name + ``` + +2. Make your changes and ensure they follow the project's coding style. + +3. Write or update tests as needed. + +4. Run the test suite to make sure all tests pass: + + ```bash + python -m pytest + ``` + +5. Commit your changes with a clear and descriptive commit message: + + ```bash + git commit -m "Add a short description of your change" + ``` + +6. Push your branch and open a pull request against `main`. + +## Development Setup + +1. Clone the repository: + + ```bash + git clone https://github.com/opprDev/template-basic.git + cd template-basic + ``` + +2. Create a virtual environment and install dependencies: + + ```bash + python -m venv .venv + source .venv/bin/activate # On Windows: .venv\Scripts\activate + pip install -r requirements.txt + ``` + +## Style Guide + +- Follow [PEP 8](https://pep8.org/) for Python code. +- Write clear, concise commit messages. +- Keep pull requests focused on a single change. + +## License + +By contributing, you agree that your contributions will be licensed under the [MIT License](LICENSE). diff --git a/README.md b/README.md index dbb8883..8e50d78 100644 --- a/README.md +++ b/README.md @@ -1 +1,51 @@ -# template-basic \ No newline at end of file +# template-basic + +A basic template repository to kickstart new projects with a solid foundation. + +## Table of Contents + +- [About](#about) +- [Getting Started](#getting-started) + - [Prerequisites](#prerequisites) + - [Installation](#installation) +- [Usage](#usage) +- [Contributing](#contributing) +- [License](#license) + +## About + +This repository serves as a basic template for new projects. It includes common configuration files, GitHub templates, and a CI workflow to help you get started quickly. + +## Getting Started + +### Prerequisites + +- Python 3.8 or higher +- pip + +### Installation + +1. Clone the repository: + + ```bash + git clone https://github.com/opprDev/template-basic.git + cd template-basic + ``` + +2. Install dependencies (if any): + + ```bash + pip install -r requirements.txt + ``` + +## Usage + +Use this template as a starting point for new projects. Click the **Use this template** button on GitHub to create a new repository based on this template. + +## Contributing + +Contributions are welcome! Please read [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on how to get involved. + +## License + +This project is licensed under the MIT License — see the [LICENSE](LICENSE) file for details.