Skip to content

Commit 6ad699d

Browse files
dileepadevdileepadev
committed
docs(repo): Add Community Standards
1 parent 48b43b5 commit 6ad699d

13 files changed

+551
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
name: 🐞 Bug Report
3+
about: Create a report to help us improve
4+
title: "🐞 Bug: Enter a short description of the issue"
5+
labels: "bug"
6+
assignees: "dileepadev"
7+
---
8+
9+
## 🐞 Bug Report
10+
11+
### 📜 Description
12+
13+
<!-- [REQUIRED] Briefly describe the bug. -->
14+
15+
### 🔄 Steps to Reproduce
16+
17+
<!-- [REQUIRED] List the steps to reproduce the bug. -->
18+
19+
<!-- example:
20+
1. Go to '...'
21+
2. Click on '...'
22+
3. Scroll down to '...'
23+
4. See error
24+
-->
25+
26+
### ✅ Expected Behavior
27+
28+
<!-- [REQUIRED] Describe what you expected to happen. -->
29+
30+
### ❌ Actual Behavior
31+
32+
<!-- [REQUIRED] Describe what actually happened. -->
33+
34+
### 📸 Screenshots
35+
36+
<!-- [OPTIONAL] If applicable, add screenshots to help explain your problem. Remove if not needed. -->
37+
38+
### ✨ Environment
39+
40+
<!-- [REQUIRED] Provide details about your environment. -->
41+
42+
<!-- example:
43+
- 🖥️ OS: [e.g. Windows, macOS, Linux]
44+
- 🌐 Browser: [e.g. Chrome, Firefox, Safari]
45+
- 📱 Device: [e.g., iPhone6, Laptop]
46+
- 📦 Version: [e.g. 22]
47+
- 🌈 Theme: [e.g. Dark mode, Light mode]
48+
-->
49+
50+
### 🔗 Related Issues or PRs
51+
52+
<!-- [OPTIONAL] Link to any related issues or pull requests. Remove if not needed. -->
53+
54+
### 📝 Additional Information
55+
56+
<!-- [OPTIONAL] Any additional context about the bug here. Remove if not needed. -->

‎.github/ISSUE_TEMPLATE/documentation_update.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
name: 📝 Documentation Update
3+
about: Propose a change to the project documentation
4+
title: "📝 Docs: Enter a short description of the issue"
5+
labels: "documentation"
6+
assignees: "dileepadev"
7+
---
8+
9+
## 📝 Documentation Update
10+
11+
### 📜 Description
12+
13+
<!-- [REQUIRED] Briefly describe the changes in this documentation update. -->
14+
15+
### 📚 Changes
16+
17+
<!-- [REQUIRED] List the specific changes made to the documentation. -->
18+
19+
### 🔗 Related Issues or PRs
20+
21+
<!-- [OPTIONAL] Link to any related issues or pull requests. Remove if not needed. -->
22+
23+
### 📝 Additional Information
24+
25+
<!-- [OPTIONAL] Any additional context about the documentation update here. Remove if not needed. -->

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
name: 🌱 Feature Request
3+
about: Suggest a feature for this project
4+
title: "🌱 Feature: Enter a short description of the issue"
5+
labels: "feature request"
6+
assignees: "dileepadev"
7+
---
8+
9+
## 🌱 Feature Request
10+
11+
### 📜 Description
12+
13+
<!-- [REQUIRED] Briefly describe the feature and the problem or opportunity it addresses. -->
14+
15+
### 🎯 Objectives
16+
17+
<!-- [REQUIRED] List the specific objectives or goals of the feature. -->
18+
19+
<!-- example:
20+
[ ] Improve user experience by adding a search function
21+
[ ] Enhance performance by optimizing the code
22+
-->
23+
24+
### 🔗 Related Issues or PRs
25+
26+
<!-- [OPTIONAL] Link to any related issues or pull requests. Remove if not needed. -->
27+
28+
### 📝 Additional Information
29+
30+
<!-- [OPTIONAL] Any additional context about the feature request here. Remove if not needed. -->

‎.github/ISSUE_TEMPLATE/feedback.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
name: 📢 Feedback
3+
about: Provide feedback for this project
4+
title: "📢 Feedback: Enter a short description of the issue"
5+
labels: "feedback"
6+
assignees: "dileepadev"
7+
---
8+
9+
## 📢 Feedback
10+
11+
### 📜 Description
12+
13+
<!-- [REQUIRED] Briefly describe the feedback. -->
14+
15+
### 🔗 Related Issues or PRs
16+
17+
<!-- [OPTIONAL] Link to any related issues or pull requests. Remove if not needed. -->
18+
19+
### 📝 Additional Information
20+
21+
<!-- [OPTIONAL] Any additional context about the feedback here. Remove if not needed. -->

‎.github/ISSUE_TEMPLATE/other.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
name: 💡 Other Issue
3+
about: Create any other issue that doesn't fit into the other categories
4+
title: "💡 Other: Enter a short description of the issue"
5+
labels: "other"
6+
assignees: "dileepadev"
7+
---
8+
9+
## 💡 Other Issue
10+
11+
### 📜 Description
12+
13+
<!-- [REQUIRED] Briefly describe the issue. -->
14+
15+
### 🔗 Related Issues or PRs
16+
17+
<!-- [OPTIONAL] Link to any related issues or pull requests. Remove if not needed. -->
18+
19+
### 📝 Additional Information
20+
21+
<!-- [OPTIONAL] Any additional context about the issue here. Remove if not needed. -->

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Pull Request
2+
3+
<!--
4+
about: Template for Pull Requests
5+
title: "<type>(<branch>): <message> [#issue_number]"
6+
# Example: "fix(dev): Link cards to a new username [#6]"
7+
-->
8+
9+
## 📜 Description
10+
11+
<!-- [REQUIRED] Briefly describe the changes in this PR and the reasoning behind them. -->
12+
13+
## ⚙️ Type of Change
14+
15+
<!-- [REQUIRED] Check the type of change your PR introduces -->
16+
17+
- [ ] 🐞 Bug Fix
18+
- [ ] 🌱 New Feature / Enhancement
19+
- [ ] 📝 Documentation Update
20+
- [ ] 📢 User Feedback / Suggestion
21+
- [ ] 💡 Other (please explain in Description)
22+
23+
## ❗ Related Issues
24+
25+
<!-- [REQUIRED] List related issue(s) or PR(s), e.g., "Closes #123" or "Related to #456". -->
26+
27+
## 📸 Screenshots
28+
29+
<!-- [OPTIONAL] If UI-related changes were made, include before/after screenshots here. Remove if not applicable.-->
30+
31+
## ✅ Checklist
32+
33+
<!-- [REQUIRED] Tick all that apply -->
34+
35+
<!-- Use "x" to check. -->
36+
<!-- example: - [x] I've followed the [CONTRIBUTING.md](CONTRIBUTING.md). -->
37+
38+
- [ ] I've followed the [CONTRIBUTING.md](CONTRIBUTING.md).
39+
- [ ] I've followed the [Commit Message Guidelines](COMMIT_MESSAGE_GUIDELINES.md).
40+
- [ ] I've followed the [Branch Naming Guidelines](BRANCH_NAMING_GUIDELINES.md).
41+
- [ ] I agree to follow the [Pull Request Guidelines](PULL_REQUEST_GUIDELINES.md).
42+
- [ ] I agree to follow the [Code of Conduct](CODE_OF_CONDUCT.md).
43+
- [ ] Documentation has been updated where necessary.
44+
- [ ] I've tested the changes where applicable.
45+
46+
<!-- example:
47+
- [ ] I've tested the changes where applicable:
48+
- [ ] Screen sizes (mobile/tablet/desktop)
49+
- [ ] Browsers (Chrome/Firefox/Safari/etc.)
50+
- [ ] Devices (iPhone/Android/Laptop/etc.)
51+
- [ ] Operating Systems (Windows/macOS/Linux)
52+
- [ ] Theme modes (Dark mode / Light mode)
53+
-->
54+
55+
## 💬 Additional Comments
56+
57+
<!-- [OPTIONAL] Any additional context, edge cases, considerations, or explanations for reviewers. Remove if not needed. -->

‎BRANCH_NAMING_GUIDELINES.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Branch Naming Guidelines
2+
3+
When creating a new branch, please follow this naming convention to maintain consistency and clarity in communication regarding the nature of changes.
4+
5+
## Protected Branches
6+
7+
These branches are protected and can only be updated by repository administrators. As a contributor, do **not** commit directly to these branches.
8+
9+
| Branch Name | Description |
10+
| ----------- | -------------------------------------------------------------------------------------- |
11+
| `main` | The stable, production-ready version of the website. |
12+
| `dev` | The development branch containing features and bug fixes not yet ready for production. |
13+
14+
## Contributing Branches
15+
16+
These branches are open for contributions from all contributors. Follow these naming conventions when creating a new branch:
17+
18+
| Branch Name | Description |
19+
| ------------ | ------------------------------------------------------------------------------------------------------ |
20+
| `feat/x` | A branch for adding new features or enhancing functionality. Replace `x` with a short description. |
21+
| `fix/x` | A branch for fixing bugs. Replace `x` with a description of the issue being addressed. |
22+
| `docs/x` | A branch for documentation updates. Replace `x` with a description of the documentation being updated. |
23+
| `style/x` | A branch for code style changes (formatting, spacing, etc.). Replace `x` with the style change. |
24+
| `refactor/x` | A branch for code refactoring that doesn’t change functionality. Replace `x` with a description. |
25+
| `perf/x` | A branch for performance improvements. Replace `x` with the specific performance enhancement. |
26+
| `test/x` | A branch for adding or modifying tests. Replace `x` with the test being added or modified. |
27+
| `chore/x` | A branch for routine tasks or maintenance (e.g., upgrading dependencies). Replace `x` with the task. |
28+
29+
## Examples
30+
31+
Here are a few examples of valid branch names:
32+
33+
- `feat/navbar` - New feature for the navbar.
34+
- `fix/login` - Bug fix for the login functionality.
35+
- `docs/readme` - Update to the README documentation.
36+
- `style/formatting` - Code style formatting changes.
37+
- `refactor/database` - Refactor the database connection handling.
38+
- `test/authentication` - Tests for the authentication service.
39+
- `chore/dependencies` - Update dependencies.

‎CHANGELOG.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Changelog
2+
3+
All notable changes to this project are documented in this file.
4+
5+
Changes are organized into the following categories:
6+
7+
- **Added:** New features or functionality introduced to the project.
8+
- **Changed:** Modifications to existing functionality that do not add new features.
9+
- **Fixed:** Bug fixes that resolve issues or correct unintended behavior.
10+
- **Removed:** Features or components that have been removed from the project.
11+
12+
## [Unreleased]
13+
14+
- Changes for the next release are available in development branches.
15+
16+
## [v1.0] - 2025-09-15
17+
18+
**Added:**
19+
20+
- Initial release of the python-certificate-generator repository.
21+
- Full changelog: <https://github.com/dileepadev/python-certificate-generator/commits/v1.0>
22+
23+
<!-- e.g., -->
24+
<!-- Unreleased -->
25+
<!-- v2.0.0 -->
26+
<!-- v1.1.0 -->
27+
<!-- v1.0.0 -->
28+
<!-- v0.0.1 -->
29+
30+
[Unreleased]: https://github.com/dileepadev/python-certificate-generator/branches
31+
32+
[v1.0]: https://github.com/dileepadev/python-certificate-generator/releases/tag/v1.0

‎COMMIT_MESSAGE_GUIDELINES.md‎

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
# Commit Message Guidelines
2+
3+
A good commit message should be descriptive and provide context about the changes made. This helps improve code review, debugging, and long-term maintainability.
4+
5+
## Commit Message Format
6+
7+
Use the following format for commit messages:
8+
9+
```md
10+
<type>(<scope>): <short message> (optional issue references)
11+
```
12+
13+
### `<type>`
14+
15+
The `<type>` field indicates the nature of the changes made in the commit. Use one of the following values:
16+
17+
| Type | Description |
18+
|----------|---------------------------------------------------------------|
19+
| feat | A new feature or enhancement to existing functionality. |
20+
| fix | A bug fix or correction of an issue. |
21+
| docs | Documentation updates (e.g., README, code comments). |
22+
| style | Code style changes (e.g., formatting, indentation, no logic). |
23+
| refactor | Code refactoring without changing external behavior. |
24+
| perf | Performance improvements. |
25+
| test | Adding or modifying tests. |
26+
| chore | Routine tasks, maintenance, or tooling changes. |
27+
28+
### `<scope>`
29+
30+
The `<scope>` is optional, but recommended. It helps clarify which part of the project the commit affects. Use one of the following scopes:
31+
32+
| Scope | Description |
33+
|-------------|---------------------------------------------|
34+
| repo | Project-wide configuration or setup |
35+
| single-agent | Changes related to the single-agent sub directory |
36+
| multi-agent | Changes related to the multi-agent sub directory |
37+
38+
### `<short message>`
39+
40+
A concise summary of what the commit does.
41+
42+
#### Writing Tips
43+
44+
- Use the imperative mood (e.g., “Add” not “Added”)
45+
- Capitalize the first letter
46+
- Don’t end with a period
47+
- Keep under 50 characters if possible
48+
- Be specific (e.g., “Add agent tools” > “Update code”)
49+
- Avoid "I", "this commit", or "fix" as vague verbs
50+
51+
### Commit Example Format
52+
53+
```md
54+
<type>(<scope>): <short message> (optional issue references)
55+
56+
<BLANK LINE>
57+
<optional longer description>
58+
```
59+
60+
**Example:**
61+
62+
```md
63+
feat(single-agent): Add agent tools (fixes #12)
64+
65+
This adds a responsive tools that connected to the external business API.
66+
```
67+
68+
### Issue References
69+
70+
Use GitHub issue references to link commits to issues.
71+
72+
#### Format
73+
74+
```md
75+
<action> #<issue_number>
76+
```
77+
78+
- `fixes #123` – closes the issue on merge
79+
- `refs #123` – just links the issue
80+
81+
#### Examples
82+
83+
```md
84+
fix(single-agent): Validate user input (fixes #42)
85+
docs(repo): Update README structure (refs #17)
86+
```
87+
88+
### Summary Table for Issue Linking (with Scope)
89+
90+
| Purpose | Example Commit Message | Result |
91+
| ---------------------- | -------------------------------------------------------------- | ---------------------------------- |
92+
| Close single issue | `fix(single-agent: Update user input validation (fixes #12)` | Links & closes issue #12 |
93+
| Reference single issue | `docs(repo): Update README structure (refs #34)` | Links issue #34 only |
94+
| Close multiple issues | `feat(single-agent): Add agent session endpoint (fixes #56, #57)` | Links & closes issues #56, #57 |
95+
| Reference multiple | `refactor(single-agent): Cleanup extra functionalities (refs #33, #38)` | Links only |
96+
97+
## ✅ Summary Example with All Fields
98+
99+
```md
100+
feat(single-agent): Add agent tools (fixes #12)
101+
102+
This adds a responsive tools that connected to the external business API.
103+
```

0 commit comments

Comments
 (0)