Skip to content

Commit 7ef03c2

Browse files
isaac-cf-wongisaac-cf-wong
committed
adapted template
1 parent 0d8b39d commit 7ef03c2

File tree

16 files changed

+438
-105
lines changed

16 files changed

+438
-105
lines changed

‎.github/template-sync.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
files:
2-
- ".gitignore" # include
2+
- ".gitignore" # include
33
- ".github"
44
- ".vscode"
55
- "tests/conftest.py"
66
- ".flake8"
77
- ".pre-commit-config.yml"
88
- ".pypirc"
99
- "docs"
10-
- "src/README.md"
1110
- "CODE_OF_CONDUCT.md"
11+
- "CONTRIBUTING.md"
1212
- "LICENSE"
1313
- "README.md"
1414
- "SECURITY.md"

‎.github/workflows/CI.yml‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
name: Python CI
22
on:
33
push:
4-
branches: [ main ]
4+
branches: [main]
55
pull_request:
6-
branches: [ main ]
6+
branches: [main]
77
release:
8-
types: [created]
8+
types: [created]
99
workflow_dispatch:
1010

1111
jobs:
@@ -15,11 +15,11 @@ jobs:
1515
python-version: ["3.9", "3.10", "3.11", "3.12"]
1616
uses: microsoft/action-python/.github/workflows/validation.yml@0.7.3
1717
with:
18-
workdir: '.'
18+
workdir: "."
1919
python-version: ${{ matrix.python-version }}
2020

21-
# publish:
22-
# uses: microsoft/action-python/.github/workflows/publish.yml@0.6.4
23-
# secrets:
24-
# PYPI_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
25-
# TEST_PYPI_PASSWORD: ${{ secrets.TEST_PYPI_PASSWORD }}
21+
publish:
22+
uses: microsoft/action-python/.github/workflows/publish.yml@0.6.4
23+
secrets:
24+
PYPI_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
25+
TEST_PYPI_PASSWORD: ${{ secrets.TEST_PYPI_PASSWORD }}

‎.github/workflows/sphinx.yml‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,5 @@ jobs:
1414
pages: write
1515
id-token: write
1616
steps:
17-
# - id: deployment
18-
# uses: sphinx-notes/pages@v3
19-
- name: Placeholder
20-
run: echo "This is a placeholder workflow."
17+
- id: deployment
18+
uses: sphinx-notes/pages@v3

‎.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,3 +127,6 @@ dmypy.json
127127

128128
# Pyre type checker
129129
.pyre/
130+
131+
# Mac metadata files
132+
.DS_store

‎CODE_OF_CONDUCT.md‎

Lines changed: 129 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,132 @@
1-
# Microsoft Open Source Code of Conduct
1+
# Contributor Covenant Code of Conduct
22

3-
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
3+
## Our Pledge
44

5-
Resources:
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, caste, color, religion, or sexual
10+
identity and orientation.
611

7-
- [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/)
8-
- [Microsoft Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
9-
- Contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with questions or concerns
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
- Demonstrating empathy and kindness toward other people
21+
- Being respectful of differing opinions, viewpoints, and experiences
22+
- Giving and gracefully accepting constructive feedback
23+
- Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
- Focusing on what is best not just for us as individuals, but for the overall
26+
community
27+
28+
Examples of unacceptable behavior include:
29+
30+
- The use of sexualized language or imagery, and sexual attention or advances of
31+
any kind
32+
- Trolling, insulting or derogatory comments, and personal or political attacks
33+
- Public or private harassment
34+
- Publishing others' private information, such as a physical or email address,
35+
without their explicit permission
36+
- Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official email address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
[INSERT CONTACT METHOD].
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series of
86+
actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or permanent
93+
ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within the
113+
community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.1, available at
119+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
120+
121+
Community Impact Guidelines were inspired by
122+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
123+
124+
For answers to common questions about this code of conduct, see the FAQ at
125+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
126+
[https://www.contributor-covenant.org/translations][translations].
127+
128+
[homepage]: https://www.contributor-covenant.org
129+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
130+
[Mozilla CoC]: https://github.com/mozilla/diversity
131+
[FAQ]: https://www.contributor-covenant.org/faq
132+
[translations]: https://www.contributor-covenant.org/translations

‎CONTRIBUTING.md‎

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
<!--
2+
Update `package_name` to the name of the package.
3+
4+
Remove the comment when this is done.
5+
-->
6+
7+
# Contributing to package name
8+
9+
<!--
10+
Update `package_name` to the name of the package.
11+
12+
Remove the comment when this is done.
13+
-->
14+
15+
🎉 Thank you for your interest in contributing to `package_name`!
16+
Your ideas, fixes, and improvements are welcome and appreciated.
17+
18+
Whether you’re fixing a typo, reporting a bug, suggesting a feature, or submitting a pull request—this guide will help you get started.
19+
20+
## 📌 How to Contribute
21+
22+
1. Open an Issue
23+
24+
<!--
25+
- Update the link to Issue.
26+
- Update `username` to the user name or organization.
27+
- Update `package_name` to the name of the package.
28+
29+
Remove the comment when this is done.
30+
-->
31+
32+
- Have a question, bug report, or feature suggestion? [Open an issue](https://github.com/username/package_name/issues/new/choose) and describe your idea clearly.
33+
- Check for existing issues before opening a new one.
34+
35+
2. Fork and Clone the Repository
36+
37+
<!--
38+
- Update the link to Issue.
39+
- Update `username` to the user name or organization.
40+
- Update `package_name` to the name of the package.
41+
42+
Remove the comment when this is done.
43+
-->
44+
45+
```shell
46+
git clone git@github.com:<username>/package_name.git
47+
cd package_name
48+
```
49+
50+
3. Set Up Your Environment
51+
52+
We recommend using a virtual environment:
53+
54+
```shell
55+
python -m venv venv
56+
source venv/bin/activate # on Windows: venv\Scripts\activate
57+
pip install -e ".[dev]"
58+
```
59+
60+
4. Set Up Pre-commit Hooks
61+
62+
We use pre-commit to ensure code quality and consistency. After installing dependencies, run:
63+
64+
```shell
65+
pre-commit install
66+
```
67+
68+
This ensures checks like code formatting, linting, and basic hygiene run automatically when you commit.
69+
70+
5. Create a New Branch
71+
72+
Give it a meaningful name like fix-typo-in-docs or feature-add-summary-option.
73+
74+
6. Make Changes
75+
76+
- Write clear, concise, and well-documented code.
77+
- Follow [PEP 8](https://pep8.org/) style conventions.
78+
- Add or update unit tests when applicable.
79+
80+
7. Run Tests
81+
82+
Ensure that all tests pass before opening a pull request:
83+
84+
```shell
85+
pytest
86+
```
87+
88+
8. Open a Pull Request
89+
90+
Clearly describe the motivation and scope of your change. Link it to the relevant issue if applicable.
91+
The pull request titles should match the [Conventional Commits spec](https://www.conventionalcommits.org/).
92+
93+
## 💡 Tips
94+
95+
- Be kind and constructive in your communication.
96+
- Keep PRs focused and atomic—smaller changes are easier to review.
97+
- Document new features and update existing docs if needed.
98+
- Tag your PR with relevant labels if you can.
99+
100+
## 📜 Licensing
101+
102+
<!--
103+
Update the statement if a different license is used.
104+
105+
Remove the comment when this is done.
106+
-->
107+
108+
By contributing, you agree that your contributions will be licensed under the project’s MIT License.
109+
110+
---
111+
112+
<!--
113+
Update package_name to the name of the package.
114+
115+
Remove the comment when this is done.
116+
-->
117+
118+
Thanks again for being part of the package_name community!
119+
120+
---

‎LICENSE‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) Microsoft Corporation.
3+
Copyright (c) Year Your name.
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

0 commit comments

Comments
 (0)