Skip to content

Commit 90f93d2

Browse files
LeonwatsoniLeonwatsoni
committed
🧽 chore: Add pull request and contributing templates for improved collaboration
1 parent f7d2f1e commit 90f93d2

5 files changed

Lines changed: 937 additions & 27 deletions

File tree

‎.github/CODE_OF_CONDUCT.md‎

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

‎.github/CONTRIBUTING.md‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
## 🤝 Contributing
2+
3+
We welcome contributions to **Chat with Logs**! Whether you’re fixing bugs, improving documentation, or adding new features, your help is appreciated.
4+
5+
### 📝 How to Contribute
6+
7+
1. **Fork the Repository**
8+
Click the **Fork** button at the top right of this repo and clone it locally:
9+
10+
```bash
11+
git clone git@github.com:dingus-technology/CHAT-WITH-LOGS.git
12+
```
13+
14+
2. **Create a New Branch**
15+
Use a descriptive name for your branch:
16+
17+
```bash
18+
git checkout -b feature/new-awesome-feature
19+
```
20+
21+
### 🔹 **Branch Naming Conventions**
22+
23+
| **Prefix** | **Purpose** | **Example** |
24+
| --------------------- | ---------------------------------------------------------------------- | -------------------------------- |
25+
| **`feature/`** | For new features or enhancements | `feature/add-logging-support` |
26+
| **`fix/`** | For bug fixes | `fix/loki-url-connection` |
27+
| **`chore/`** | For maintenance tasks (e.g., refactoring, dependency updates) | `chore/update-dependencies` |
28+
| **`hotfix/`** | For urgent fixes in production | `hotfix/fix-auth-token-bug` |
29+
| **`refactor/`** | For restructuring or improving existing code without changing behavior | `refactor/clean-api-handlers` |
30+
| **`docs/`** | For documentation updates | `docs/update-readme` |
31+
| **`test/`** | For adding or updating tests | `test/integration-tests-logging` |
32+
| **`release/`** | For preparing a new release | `release/v1.2.0` |
33+
| **`ci/` or `build/`** | For CI/CD pipeline updates | `ci/update-github-actions` |
34+
35+
💡 **Best Practices**:
36+
- Use **kebab-case** (hyphen-separated words) for readability.
37+
- Keep branch names **descriptive** but **concise**.
38+
- Use issue/ticket numbers when relevant (e.g., `feature/123-add-user-auth`).
39+
40+
3. **Make Your Changes**
41+
- Ensure your code is clean and well-documented.
42+
- Run code checks before committing:
43+
44+
```bash
45+
format-checks
46+
code-checks
47+
```
48+
49+
4. **Commit and Push**
50+
```bash
51+
git add .
52+
git commit -m "Add feature: new awesome functionality"
53+
git push origin feature/new-awesome-feature
54+
```
55+
56+
5. **Submit a Pull Request (PR)**
57+
- Open a PR against the `main` branch.
58+
- Provide a clear description of the changes and their purpose.
59+
- Follow the `PULL_REQUEST_TEMPLATE.md`.
60+
61+
### 🐛 Reporting Issues
62+
63+
Found a bug? Have a feature request? Please **open an issue** [here](https://github.com/dingus-technology/chat-with-logs/issues) with:
64+
- A clear description of the issue.
65+
- Steps to reproduce (if applicable).
66+
- Expected vs. actual behavior.
67+
- Screenshot of issue.
68+
69+
### ✅ Contribution Guidelines
70+
71+
- Ensure your changes align with the project's goal.
72+
- Follow the existing coding style and structure.
73+
- Write meaningful commit messages - emojis encouraged i.e. `🐛 fix: bug removed`.
74+
- Leave no trace - do not leave comments - clear code and doc strings alleviate the need for comments.
75+
76+
---
77+
78+
💡 **Join us in making debugging smarter and faster!** 🚀

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# 🚀 < Pull Request Title >
2+
3+
## 🔍 Changes
4+
5+
- **[`< File Name >`]**: [Briefly explain what changed, why it was changed, and how it was implemented]
6+
- **[`< File Name >`]**: [Additional changes if applicable]
7+
- **[`< File Name >`]**: [Mention any refactoring, bug fixes, or improvements]
8+
9+
## 📸 Screenshot/Image of Change (if applicable)
10+
11+
_Add a screenshot or image showcasing the update:_
12+
13+
![Screenshot Description](URL or drag & drop the image here)
14+
15+
📌 **Caption:** [Describe what the image shows]
16+
17+
## ✅ Checklist
18+
19+
- [ ] My code follows the project’s style guidelines.
20+
- [ ] I have tested my changes locally.
21+
- [ ] I have updated the documentation (if needed).
22+
- [ ] No new warnings or errors.
23+
- [ ] All comments have been removed unless absolutely necessary.
24+
25+
## 🔗 Related Issues (if any)
26+
27+
Closes #ISSUE_NUMBER

0 commit comments

Comments
 (0)