Skip to content

Commit 4237d0e

Browse files
recursivezerorecursivezero
authored
Initial commit
0 parents  commit 4237d0e

30 files changed

Lines changed: 1389 additions & 0 deletions

‎.github/CODEOWNERS‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
2+
* @recursivezero
3+
4+
# You can also use email addresses if you prefer
5+
6+
docs/* recursivelyzero@gmail.com

‎.github/CODE_OF_CONDUCT.md‎

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

‎.github/CONTRIBUTING.md‎

Lines changed: 199 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,199 @@
1+
# Contribute
2+
3+
This article explains how to contribute to project. Please read through the following guidelines.
4+
5+
Write something nice and instructive as an intro. Talk about what kind of contributions you are interested in.
6+
7+
> Welcome! We love receiving contributions from our community, so thanks for stopping by! There are many ways to contribute, including submitting bug reports, improving documentation, submitting feature requests, reviewing new submissions,
8+
> or contributing code that can be incorporated into the project.
9+
10+
## Summary
11+
12+
> [!Note]
13+
> Before participating in our community, please read our [code of conduct][coc].
14+
> By interacting with this repository, organization, or community you agree to abide by its terms.
15+
16+
This document describes our development process. Following these guidelines shows that you respect the time and effort of the developers managing this project. In return, you will be shown respect in addressing your issue,
17+
reviewing your changes, and incorporating your contributions.
18+
19+
## Contributions
20+
21+
There’s several ways to contribute, not just by writing code. If you have questions, see [support][support].
22+
23+
### Financial support
24+
25+
It’s possible to support us financially by becoming a backer or sponsor through [Open Collective][collective].
26+
27+
### Improve docs
28+
29+
As a user you’re perfect for helping us improve our docs.Typo corrections, error fixes, better explanations, new examples, etcetera.
30+
31+
### Improve issues
32+
33+
Some issues lack information, aren’t reproducible, or are just incorrect. You can help by trying to make them easier to resolve.
34+
Existing issues might benefit from your unique experience or opinions.
35+
36+
### Write code
37+
38+
Code contributions are very welcome.
39+
It’s probably a good idea to first post a question or open an issue to report a bug or suggest a new feature before creating a pull request.
40+
41+
## Submitting an issue
42+
43+
- The issue tracker is for issues. Use discussions for support
44+
- Search the issue tracker (including closed issues) before opening a new issue
45+
- Ensure you’re using the latest version of our packages
46+
- Use a clear and descriptive title
47+
- Include as much information as possible: steps to reproduce the issue, error message, version, operating system, etcetera
48+
- The more time you put into an issue, the better we will be able to help you
49+
- The best issue report is a proper reproduction step to prove it
50+
51+
## Development Process
52+
53+
What is your development process?
54+
55+
> [!Tip]
56+
> This project follows the basic git glow
57+
58+
Check and follow [README][readme] file and run on your local.
59+
60+
Talk about branches people should work on. Specifically, where is the starting point? `main`, `feature`, `hotfix` `task` etc.
61+
62+
### Testing
63+
64+
If you add code you need to add tests! We’ve learned the hard way that code without tests is undependable. If your pull request reduces our test coverage because it lacks tests then it will be rejected.
65+
66+
Provide instructions for adding new tests. Provide instructions for running tests.
67+
68+
```sh
69+
npm run test
70+
```
71+
72+
### Style Guidelines
73+
74+
run below command
75+
76+
```sh
77+
npm run lint
78+
```
79+
80+
### Code Formatting
81+
82+
use code formatter in your IDE, add prettier and some other useful extension in your IDE.
83+
84+
### Git Commit Guidelines
85+
86+
below are the guidelines for your commit messages.
87+
88+
- add clear message and with 50 lines
89+
- prefix feature / issue number from issue page
90+
91+
### Submitting a pull request
92+
93+
- Run `npm test` locally to build, format, and test your changes
94+
- Non-trivial changes are often best discussed in an issue first, to prevent you from doing unnecessary work
95+
- For ambitious tasks, you should try to get your work in front of the community for feedback as soon as possible
96+
- New features should be accompanied by tests and documentation
97+
- Don’t include unrelated changes
98+
- Test before submitting code by running `npm test`
99+
- Write a convincing description of why we should land your pull request: it’s your job to convince us
100+
101+
## Pull Request Process
102+
103+
Add notes for pushing your branch:
104+
105+
When you are ready to generate a pull request, either for preliminary review, or for consideration of merging into the project you must first push your local topic branch back up to GitHub:
106+
107+
```sh
108+
git push origin feature/branch-name
109+
```
110+
111+
Include a note about submitting the PR:
112+
113+
Once you've committed and pushed all of your changes to GitHub, go to the page for your fork on GitHub, select your development branch, and click the pull request button.
114+
If you need to make any adjustments to your pull request, just push the updates to your branch. Your pull request will automatically track the changes on your development branch and update.
115+
116+
1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
117+
2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
118+
3. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
119+
4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.
120+
121+
### Review Process
122+
123+
Who reviews it? Who needs to sign off before it’s accepted? When should a contributor expect to hear from you? How can contributors get commit access, if at all?
124+
125+
- The core team looks at Pull Requests on a regular basis in a weekly triage meeting that we hold in a public domain. The is announced in the weekly status updates.
126+
- Our Reviewer will provide constructive Feedback by writing Review Comments (RC). Pull Requester have to address all RC on time.
127+
- After feedback has been given we expect responses within two weeks. After two weeks we may close the pull request if it isn't showing any activity.
128+
- Except for critical, urgent or very small fixes, we try to leave pull requests open for most of the day or overnight if something comes in late in the day, so that multiple people have the chance to review/comment.
129+
Anyone who reviews a pull request should leave a note to let others know that someone has looked at it. For larger commits, we like to have a +1 from someone else on the core team and/or from other contributor(s).
130+
Please note if you reviewed the code or tested locally -- a +1 by itself will typically be interpreted as your thinking its a good idea, but not having reviewed in detail.
131+
132+
Perhaps also provide the steps your team will use for checking a PR. Or discuss the steps run on your CI server if you have one. This will help developers understand how to investigate any failures or test the process on their own.
133+
134+
### Addressing Feedback
135+
136+
Once a PR has been submitted, your changes will be reviewed and constructive feedback may be provided. Feedback isn't meant as an attack, but to help make sure the highest-quality code makes it into our project.
137+
Changes will be approved once required feedback has been addressed.
138+
139+
If a maintainer asks you to "rebase" your PR, they're saying that a lot of code has changed, and that you need to update your fork so it's easier to merge.
140+
141+
To update your forked repository, follow these steps:
142+
143+
### Fetch upstream master and merge with your repo's main branch
144+
145+
```sh
146+
git fetch upstream
147+
git checkout main
148+
git merge upstream/main
149+
```
150+
151+
#### If there were any new commits, rebase your development branch
152+
153+
```sh
154+
git checkout feature/branch-name
155+
git rebase main
156+
```
157+
158+
If too much code has changed for git to automatically apply your branches changes to the new master, you will need to manually resolve the merge conflicts yourself.
159+
160+
Once your new branch has no conflicts and works correctly, you can override your old branch using this command:
161+
162+
```sh
163+
git push origin feature/branch-name
164+
```
165+
166+
Note that this will overwrite the old branch on the server, so make sure you are happy with your changes first!
167+
168+
## Community
169+
170+
Do you have a mailing list, Google group, slack channel, IRC channel? Link to them here.
171+
172+
Include Other Notes on how people can contribute
173+
174+
- You can help us answer questions our users have here:
175+
- You can help build and design our website here:
176+
- You can help write blog posts about the project by:
177+
- You can help with newsletters and internal communications by:
178+
179+
- Create an example of the project in real world by building something or showing what others have built.
180+
- Write about other people’s projects based on this project. Show how it’s used in daily life. Take screenshots and make videos!
181+
182+
## Resources
183+
184+
- [How to contribute to open source](https://opensource.guide/how-to-contribute/)
185+
- [Making your first contribution](https://medium.com/@vadimdemedes/making-your-first-contribution-de6576ddb190)
186+
- [Using pull requests](https://help.github.com/articles/about-pull-requests/)
187+
- [GitHub help](https://help.github.com)
188+
- [git commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
189+
190+
## Author
191+
192+
© RecursiveZero Private Limited
193+
194+
<!-- Definitions -->
195+
196+
[collective]: https://opencollective.com/recursivezero
197+
[readme]: https://github.com/recursivezero/template/blob/main/README.md
198+
[support]: https://github.com/recursivezero/template/blob/main/.github/SUPPORT.md
199+
[coc]: https://github.com/recursivezero/template/blob/main/.github/CODE_OF_CONDUCT.md

‎.github/DISCUSSION_TEMPLATE/announcements.yml‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
title: "[General] "
2+
labels: ["General Introduction"]
3+
body:
4+
- type: markdown
5+
attributes:
6+
value: |
7+
introduce yourself!
8+
9+
- type: textarea
10+
id: improvements
11+
attributes:
12+
label: Top 3 improvements
13+
description: "What are the top 3 improvements we could make to this project?"
14+
value: |
15+
1.
16+
2.
17+
3.
18+
...
19+
render: bash
20+
validations:
21+
required: true
22+
23+
- type: textarea
24+
id: has-id
25+
attributes:
26+
label: write us suggestion
27+
description: A description about suggestions to help you
28+
validations:
29+
required: true
30+
31+
- type: checkboxes
32+
id: terms
33+
attributes:
34+
label: Before submitting
35+
description: By submitting this announcement, you agree to follow our [Contributing Guidelines](https://github.com/recursivezero/template/blob/main/.github/CONTRIBUTING.md).
36+
options:
37+
- label: I've made research efforts and searched the documentation
38+
required: true

0 commit comments

Comments
 (0)