Skip to content

Commit 5eeac4f

Browse files
hanzydevhanzydev
committed
feat: update README, add issue templates, and enhance contributing guidelines
1 parent 90758db commit 5eeac4f

File tree

11 files changed

+338
-3
lines changed

11 files changed

+338
-3
lines changed

‎.github/ISSUE_TEMPLATE/bug-report.yml‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: "\U0001F41E Bug report"
2+
description: Report an issue or bug
3+
labels: ['🚧 pending triage']
4+
body:
5+
- type: textarea
6+
id: bug-description
7+
attributes:
8+
label: Describe the bug
9+
description: A clear and concise description of what the bug is. If you intend to submit a PR for this issue, tell us in the description. Thanks!
10+
placeholder: Bug description
11+
validations:
12+
required: true
13+
- type: textarea
14+
id: additional
15+
attributes:
16+
label: Additional context
17+
description: If applicable, add any other context about the problem here

‎.github/ISSUE_TEMPLATE/feature-request.yml‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: '🚀 Feature request'
2+
description: Suggest a feature or improvement
3+
labels: ['🚧 pending triage']
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thank you for taking the time to fill out this feature request!
9+
- type: textarea
10+
id: feature-description
11+
attributes:
12+
label: Describe the feature
13+
description: A clear and concise description of what you think would be a helpful addition, including the possible use cases and alternatives you have considered. If you have a working prototype or module that implements it, please include a link.
14+
placeholder: Feature description
15+
validations:
16+
required: true
17+
- type: checkboxes
18+
id: additional-info
19+
attributes:
20+
label: Additional information
21+
description: Additional information that helps us decide how to proceed.
22+
options:
23+
- label: Would you be willing to help implement this feature?

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
<!---
2+
3+
*** IMPORTANT: PLEASE READ BEFORE CONTINUING TO MAKE A PULL REQUEST ***
4+
5+
- The title should follow conventional commits (https://conventionalcommits.org).
6+
7+
- - If it is a bug fix, please make sure there is a reproduction related issue and/or enough context to explain what exactly is being fixed and why this fix is the best option.
8+
9+
- If it is a new feature, please ensure it has already been discussed. Keep the scope of changes minimal to what is essential, and try to break down your changes into smaller PRs when possible.
10+
11+
- After submitting, please remain patient until your PR is reviewed.
12+
13+
Thanks for your contribution ❤️
14+
-->
15+
16+
### 🔗 Linked issue
17+
18+
<!-- Please ensure there is an open issue and mention its number as #123 -->
19+
20+
### ❓ Type of change
21+
22+
<!-- What types of changes does your code introduce? Put an `x` in all the boxes that apply. -->
23+
24+
- [ ] 🐞 Bug fix (a non-breaking change that fixes an issue)
25+
- [ ] 👌 Enhancement (improving an existing functionality like performance)
26+
- [ ] ✨ New feature (a non-breaking change that adds functionality)
27+
- [ ] 🧹 Chore (updates to the build process or auxiliary tools and libraries)
28+
- [ ] 🛠️ Refactor (a code change that neither fixes a bug nor adds a feature)
29+
- [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to change)
30+
31+
### 📚 Description
32+
33+
<!-- Describe your changes in detail -->
34+
<!-- Why is this change required? What problem does it solve? -->
35+
<!-- If it resolves an open issue, please link to the issue here. For example "Resolves #1337" -->
36+
37+
### 📝 Checklist
38+
39+
<!-- Put an `x` in all the boxes that apply. -->
40+
<!-- If your change requires a documentation PR, please link it appropriately -->
41+
<!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
42+
43+
- [ ] I have linked an issue or discussion.

‎.github/workflows/check.yml‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: check
2+
on:
3+
push:
4+
pull_request:
5+
branches:
6+
- main
7+
jobs:
8+
check:
9+
runs-on: ubuntu-latest
10+
11+
steps:
12+
- uses: actions/checkout@v4
13+
- uses: pnpm/action-setup@v4
14+
15+
- name: Use Node.js 20
16+
uses: actions/setup-node@v4
17+
with:
18+
node-version: 20
19+
cache: 'pnpm'
20+
21+
- name: Install dependencies
22+
run: pnpm install --frozen-lockfile
23+
24+
- name: Lint & Test build
25+
run: pnpm check

‎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+
contact@hanzy.dev.
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: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
## Contributing
2+
3+
[fork]: /fork
4+
[pr]: /compare
5+
[style]: https://standardjs.com/
6+
[code-of-conduct]: CODE_OF_CONDUCT.md
7+
8+
Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
9+
10+
Please note that this project is released with a [Contributor Code of Conduct][code-of-conduct]. By participating in this project you agree to abide by its terms.
11+
12+
## Issues and PRs
13+
14+
If you have suggestions for how this project could be improved, or want to report a bug, open an issue! We'd love all and any contributions. If you have questions, too, we'd love to hear them.
15+
16+
We'd also love PRs. If you're thinking of a large PR, we advise opening up an issue first to talk about it, though! Look at the links below if you're not sure how to open a PR.
17+
18+
## Submitting a pull request
19+
20+
1. [Fork][fork] and clone the repository.
21+
1. Configure and install the dependencies: `pnpm i`.
22+
1. Create a new branch: `git checkout -b my-branch-name`.
23+
1. Make your change.
24+
1. Push to your fork and [submit a pull request][pr].
25+
1. Pat your self on the back and wait for your pull request to be reviewed and merged.
26+
27+
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
28+
29+
- Follow the [style guide][style] which is using standard. Any linting errors should be shown when running `pnpm check`.
30+
- Keep your changes as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
31+
- Use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) for your commit messages.
32+
33+
Work in Progress pull requests are also welcome to get feedback early on, or if there is something blocked you.
34+
35+
## Resources
36+
37+
- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
38+
- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
39+
- [GitHub Help](https://help.github.com)

‎LICENSE‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Copyright 2025 hanzydev
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
4+
5+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
6+
7+
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

‎README.md‎

Lines changed: 43 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,43 @@
1-
# selamunaleykum dunya
1+
# Nodesty API Client
2+
3+
A powerful API client for Nodesty.
4+
5+
## 📦 Features
6+
7+
- ⚡ Fast & Secure
8+
- 🔌 Easy to use
9+
- ✅ Type-Safe
10+
- ⚙️ Modular & Scalable
11+
- 💯 %100 Coverage of Nodesty API
12+
13+
## 🚀 Getting Started
14+
15+
### Installation
16+
17+
```bash
18+
npx nypm i @nodesty/api-client
19+
```
20+
21+
### Usage
22+
23+
```javascript
24+
import { NodestyApiClient } from '@nodesty/api-client';
25+
26+
const api = new NodestyApiClient({
27+
accessToken: 'YOUR_NODESTY_PERSONAL_ACCESS_TOKEN',
28+
});
29+
30+
// Now you can access different services:
31+
const user = api.user;
32+
const vps = api.vps;
33+
const firewall = api.firewall;
34+
const dedicatedServer = api.dedicatedServer;
35+
```
36+
37+
## ❤️ Contribute
38+
39+
Contributions are always welcome! Please read the [contribution guidelines](CONTRIBUTING.md) first.
40+
41+
## ⚖️ License
42+
43+
[MIT](LICENSE)

‎package.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@
1111
"build": "tsdown",
1212
"lint": "prettier --check . && eslint .",
1313
"lint:fix": "prettier --write . && eslint . --fix",
14-
"release": "changelogen --release"
14+
"release": "changelogen --release",
15+
"check": "pnpm build && pnpm lint"
1516
},
1617
"repository": {
1718
"type": "git",

‎renovate.json‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
3+
"extends": ["config:recommended", ":semanticCommitTypeAll(chore)", ":dependencyDashboard"],
4+
"labels": ["🧩 dependencies"],
5+
"major": {
6+
"dependencyDashboardApproval": true
7+
},
8+
"timezone": "Europe/Istanbul",
9+
"rangeStrategy": "bump"
10+
}

0 commit comments

Comments
 (0)