Skip to content

Commit f87daf4

Browse files
jcodogjcodog
committed
2 parents a32166f + ccd137b commit f87daf4

7 files changed

Lines changed: 347 additions & 0 deletions

File tree

‎.github/FUNDING.yml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# These are supported funding model platforms
2+
3+
github: JCoNet # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
4+
patreon: # Replace with a single Patreon username
5+
open_collective: # Replace with a single Open Collective username
6+
ko_fi: # Replace with a single Ko-fi username
7+
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
8+
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
9+
liberapay: # Replace with a single Liberapay username
10+
issuehunt: # Replace with a single IssueHunt username
11+
lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
12+
polar: # Replace with a single Polar username
13+
buy_me_a_coffee: # Replace with a single Buy Me a Coffee username
14+
thanks_dev: # Replace with a single thanks.dev username
15+
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Desktop (please complete the following information):**
27+
- OS: [e.g. iOS]
28+
- Browser [e.g. chrome, safari]
29+
- Version [e.g. 22]
30+
31+
**Smartphone (please complete the following information):**
32+
- Device: [e.g. iPhone6]
33+
- OS: [e.g. iOS8.1]
34+
- Browser [e.g. stock browser, safari]
35+
- Version [e.g. 22]
36+
37+
**Additional context**
38+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

‎CODE_OF_CONDUCT.md‎

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
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, religion, or sexual identity
10+
and orientation.
11+
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
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of 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
35+
address, 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 e-mail 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+
customer_support@jconet.co.uk.
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
86+
of 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
93+
permanent 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
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
https://www.contributor-covenant.org/faq. Translations are available at
128+
https://www.contributor-covenant.org/translations.

‎CONTRIBUTING.md‎

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
# Community Guidelines
2+
3+
Thank you for your interest in the **cod-stats-parser** project! These guidelines outline our expectations for community interactions and contributions. Please read them carefully to help foster a welcoming and collaborative environment.
4+
5+
## 1. Purpose of This Repository
6+
7+
- **Primary Goal**: This GitHub repository serves as a central place to develop, maintain, and discuss improvements for the **cod-stats-parser** application.
8+
- **Audience**: While this is a company repo, it is publicly available, allowing more people to view and potentially contribute.
9+
- **Scope**: We welcome suggestions, bug reports, feature requests, and pull requests that help make this tool more robust and user-friendly.
10+
11+
## 2. Code of Conduct
12+
13+
We adhere to a few core principles to keep our community respectful and inclusive:
14+
15+
- **Respect**: Treat fellow community members with kindness, empathy, and courtesy.
16+
- **Constructive Feedback**: Provide feedback that is specific, actionable, and helpful. Critique the idea, not the person.
17+
- **Inclusivity**: Embrace diversity in skill levels, backgrounds, and perspectives. Discrimination or harassment is not tolerated.
18+
- **No Harassment**: Examples of unacceptable behavior include, but are not limited to, offensive comments or personal attacks, threats of violence, and unwelcome sexual attention.
19+
20+
If you experience or witness any behavior that violates these principles, please [open an issue](../../issues) or contact the repository maintainers directly.
21+
22+
## 3. Contribution Guidelines
23+
24+
We welcome community contributions—be they code, documentation, or feedback. To ensure a smooth process, please follow these guidelines:
25+
26+
### 3.1 Fork, Then Clone
27+
28+
1. **Fork** this repository to your own GitHub account.
29+
2. **Clone** the forked project locally for development.
30+
31+
```bash
32+
git clone https://github.com/YOUR_USERNAME/cod-stats-parser.git
33+
```
34+
35+
### 3.2 Create a Feature Branch
36+
37+
We recommend creating a feature branch for all changes:
38+
39+
```bash
40+
git checkout -b feature/your-feature-name
41+
```
42+
43+
### 3.3 Commit and Push Changes
44+
45+
Regularly commit your changes with concise, descriptive messages:
46+
47+
```bash
48+
git commit -m "Implement new feature or fix a bug"
49+
git push origin feature/your-feature-name
50+
```
51+
52+
### 3.4 Submit a Pull Request
53+
54+
Once you are confident that your changes are ready:
55+
56+
1. Go to your forked repository on GitHub.
57+
2. Click **Compare & pull request** to compare your branch with the `main` branch of the main repository.
58+
3. Provide a clear title and description of your changes.
59+
4. Submit the pull request.
60+
61+
**Note**: Please ensure your pull request is well-tested, documented, and follows any applicable style conventions.
62+
63+
## 4. Issue Reporting
64+
65+
We appreciate your help in making our project better. If you encounter a bug or have a feature request, please follow these steps:
66+
67+
1. Check [open issues] to see if someone else has already reported it.
68+
2. If not, open a **new issue**.
69+
3. Provide as much detail as possible, including steps to reproduce the problem, expected behavior, and additional context.
70+
71+
## 5. Communication
72+
73+
For general discussions, feedback, or questions, feel free to:
74+
75+
- **Open a Discussion**: Use the [Discussions](../../discussions) tab (if enabled) or open an issue labeled “Question/Discussion.”
76+
- **Pull Request Comments**: Use the comments section within a pull request to clarify any part of the code or proposed changes.
77+
- **Direct Contact**: If you need to reach out privately, you can email the repository maintainers (contact info can be found in the repo or company website).
78+
79+
## 6. Licensing and Usage
80+
81+
- **License**: This project is provided under the MIT license. Please review the [LICENSE](?tab=MIT-1-ov-file) file for full details on usage, reproduction, and distribution.
82+
- **Attribution**: If you use or adapt this project, we encourage you to link back to this repository so others can find the source.
83+
84+
## 7. Disclaimer
85+
86+
While this project is publicly accessible, it remains a **company repository**. All contributors must acknowledge that:
87+
88+
- **Confidentiality**: Certain information may still be proprietary to our organization. Avoid sharing any sensitive or private data in commits, issues, or discussions.
89+
- **Warranty**: This application is provided “as is,” with no warranty or liability from the repository owners.
90+
91+
## 8. Enforcement
92+
93+
Failure to follow these guidelines may result in actions such as a warning, temporary ban, or permanent removal from our community spaces—at the discretion of the maintainers.
94+
95+
## 9. Feedback and Improvements
96+
97+
We are always looking to improve these guidelines to keep the community positive and productive. If you have suggestions or insights, feel free to open an issue or discussion.
98+
```

‎PULL_REQUEST_TEMPLATE.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Description
2+
3+
Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change.
4+
5+
Fixes # (issue)
6+
7+
## Type of change
8+
9+
Please delete options that are not relevant.
10+
11+
- [ ] Bug fix (non-breaking change which fixes an issue)
12+
- [ ] New feature (non-breaking change which adds functionality)
13+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
14+
- [ ] This change requires a documentation update
15+
16+
# How Has This Been Tested?
17+
18+
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
19+
20+
- [ ] Test A
21+
- [ ] Test B
22+
23+
**Test Configuration**:
24+
* Firmware version:
25+
* Hardware:
26+
* Toolchain:
27+
* SDK:
28+
29+
# Checklist:
30+
31+
- [ ] My code follows the style guidelines of this project
32+
- [ ] I have performed a self-review of my code
33+
- [ ] I have commented my code, particularly in hard-to-understand areas
34+
- [ ] I have made corresponding changes to the documentation
35+
- [ ] My changes generate no new warnings
36+
- [ ] I have added tests that prove my fix is effective or that my feature works
37+
- [ ] New and existing unit tests pass locally with my changes
38+
- [ ] Any dependent changes have been merged and published in downstream modules
39+

‎SECURITY.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Reporting Security Issues
2+
3+
The JCoNet LTD team and community take security bugs in Electron seriously. We appreciate your efforts to responsibly disclose your findings, and will make every effort to acknowledge your contributions.
4+
5+
To report a security issue, please use the GitHub Security Advisory ["Report a Vulnerability"](https://github.com/electron/electron/security/advisories/new) tab.
6+
7+
The Electron team will send a response indicating the next steps in handling your report. After the initial reply to your report, the security team will keep you informed of the progress towards a fix and full announcement, and may ask for additional information or guidance.
8+
9+
Report security bugs in third-party modules to the person or team maintaining the module. You can also report a vulnerability through the [npm contact form](https://www.npmjs.com/support) by selecting "I'm reporting a security vulnerability".

0 commit comments

Comments
 (0)