Skip to content

Commit e8e444e

Browse files
⚙️ Chore(enviroment): add husky and other basic boilerplate MD Files
1 parent a5bcc8b commit e8e444e

4 files changed

Lines changed: 929 additions & 7458 deletions

File tree

CODE_OF_CONDUCT.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
- Using welcoming and inclusive language
18+
- Being respectful of differing viewpoints and experiences
19+
- Gracefully accepting constructive criticism
20+
- Focusing on what is best for the community
21+
- Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
- The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
- Trolling, insulting/derogatory comments, and personal or political attacks
28+
- Public or private harassment
29+
- Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
- Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at ineedjobtostartwork@gmail.com. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org
74+
75+
For answers to common questions about this code of conduct, see
76+
https://www.contributor-covenant.org/faq

CONTRIBUTING.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Contributing Rules
2+
3+
[**Global Contributing Rules**](https://github.com/INeedJobToStartWork/INeedJobToStartWork/tree/main/other/contribute/CONTRIBUTING.md) - Here you can find general contribution guide for most of [INEEDJ](https://github.com/INeedJobToStartWork) projects.
4+
5+
## Local contributing rules
6+
7+
_empty_

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,12 @@ Currently:
1313
- Documentation is outdated
1414
- Types are outdated
1515
- Not friendly for developers to use it as Dependency
16+
- Not minified
1617

1718
## Mission
1819

20+
- 100% original functionality (Maybe extras sometimes)
21+
- Refactor on Typescript
1922
- Make Dependencies easier in use for developers of external packages
2023
- Up-to-date documentation
2124
- Correct types
@@ -28,11 +31,11 @@ About packages:
2831

2932
- 📖 TSDocs (Internal documentation)
3033
- ♻️ Minified
31-
- ⚠️ Error Handler (Custom - `oh-my-error`)
34+
- ⚠️ Error Handler (Custom - `oh-my-error`, why this?)
3235
- ✅ Support JS/TS & CJS/ESM
3336
- 📝 Debug Logging (Only for CLI commands)
3437

35-
## Packages:
38+
## Packages
3639

3740
### Status
3841

0 commit comments

Comments
 (0)