Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
alessiofrittoli authored Dec 13, 2024
0 parents commit 7e3de26
Show file tree
Hide file tree
Showing 21 changed files with 5,324 additions and 0 deletions.
12 changes: 12 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
root = true

[*]
indent_style = tab
indent_size = 4
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = false

[*.md]
trim_trailing_whitespace = false
1 change: 1 addition & 0 deletions .env.test
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
VAR_LOADED=true
76 changes: 76 additions & 0 deletions .github/rulesets/Default branch ruleset.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
{
"name": "Default branch ruleset",
"target": "branch",
"source_type": "Repository",
"source": "alessiofrittoli/node-module-starter",
"enforcement": "active",
"conditions": {
"ref_name": {
"exclude": [],
"include": [
"~DEFAULT_BRANCH"
]
}
},
"rules": [
{
"type": "deletion"
},
{
"type": "non_fast_forward"
},
{
"type": "creation"
},
{
"type": "update"
},
{
"type": "required_linear_history"
},
{
"type": "required_signatures"
},
{
"type": "pull_request",
"parameters": {
"required_approving_review_count": 0,
"dismiss_stale_reviews_on_push": true,
"require_last_push_approval": true,
"required_review_thread_resolution": true,
"automatic_copilot_code_review_enabled": false,
"allowed_merge_methods": [
"squash",
"rebase"
]
}
},
{
"type": "required_status_checks",
"parameters": {
"strict_required_status_checks_policy": true,
"do_not_enforce_on_create": false,
"required_status_checks": []
}
},
{
"type": "code_scanning",
"parameters": {
"code_scanning_tools": [
{
"tool": "CodeQL",
"security_alerts_threshold": "high_or_higher",
"alerts_threshold": "errors"
}
]
}
}
],
"bypass_actors": [
{
"actor_id": 5,
"actor_type": "RepositoryRole",
"bypass_mode": "always"
}
]
}
50 changes: 50 additions & 0 deletions .github/rulesets/Tagging ruleset.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
{
"name": "Tagging ruleset",
"target": "tag",
"source_type": "Repository",
"source": "alessiofrittoli/node-module-starter",
"enforcement": "active",
"conditions": {
"ref_name": {
"exclude": [],
"include": [
"~ALL"
]
}
},
"rules": [
{
"type": "deletion"
},
{
"type": "non_fast_forward"
},
{
"type": "creation"
},
{
"type": "update"
},
{
"type": "required_linear_history"
},
{
"type": "required_signatures"
},
{
"type": "required_status_checks",
"parameters": {
"strict_required_status_checks_policy": true,
"do_not_enforce_on_create": false,
"required_status_checks": []
}
}
],
"bypass_actors": [
{
"actor_id": 5,
"actor_type": "RepositoryRole",
"bypass_mode": "always"
}
]
}
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
/dist
/node_modules

.env.*
!.env.test
.DS_Store
17 changes: 17 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
/src
/__tests__
/docs

/node_modules
/.git
/.github

.gitignore
.env.*
.DS_Store

eslint.config.mjs
jest.config.ts
jest.setup.ts
tsconfig.json
tsup.config.ts
12 changes: 12 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
// See https://go.microsoft.com/fwlink/?LinkId=827846 to learn about workspace recommendations.
// Extension identifier format: ${publisher}.${name}. Example: vscode.csharp

// List of extensions which should be recommended for users of this workspace.
"recommendations": [
"dbaeumer.vscode-eslint",
"davidanson.vscode-markdownlint",
],
// List of extensions recommended by VS Code that should not be recommended for users of this workspace.
"unwantedRecommendations": []
}
10 changes: 10 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"workbench.colorCustomizations": {
"titleBar.activeBackground": "#212121",
"titleBar.border": "#CB3837",
"titleBar.activeForeground": "#F0F0F0",
"statusBar.background": "#212121",
"statusBar.border":"#CB3837",
"statusBar.foreground": "#F0F0F0",
},
}
49 changes: 49 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Code of Conduct

## Our Pledge

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 and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our community include:

- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
- Focusing on what is best not just for us as individuals, but for the overall community

Examples of unacceptable behavior include:

- The use of sexualized language or imagery, and sexual attention or advances of any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others’ private information, such as a physical or email address, without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting

## Enforcement Responsibilities

Project maintainers are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.

All project maintainers are obligated to respect the privacy and security of the reporter of any incident.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1,
available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct/][version]

[homepage]: http://contributor-covenant.org
[version]: https://www.contributor-covenant.org/version/2/1
94 changes: 94 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
# Contributing to Node Module Starter 🛠️

We’re excited that you’re interested in contributing to Node Module Starter! This guide will help you get started.

## How to Contribute

### 1. Report Issues

If you find a bug, have a question, or want to suggest a new feature:

- Search Existing Issues: Check the [Issues](https://github.com/alessiofrittoli/node-module-starter/issues) tab to see if your concern has already been addressed.
- Create a New Issue: If not, open a new issue. Please provide:
- A clear and descriptive title.
- Detailed steps to reproduce the issue (if applicable).
- Suggestions or ideas (if applicable).

### 2. Fork the Repository

Please, take a look at [Contributing to a project - GitHub Docs](https://docs.github.com/en/get-started/exploring-projects-on-github/contributing-to-a-project) page for more in-detail informations.

- Go to the [repository page](https://github.com/alessiofrittoli/node-module-starter).
- Click the Fork button.
- Clone your fork to your local machine:

```bash
git clone https://github.com/your-username/node-module-starter.git
```

### 3. Create a Branch

To make changes:

- Navigate to your cloned repository:

```bash
cd node-module-starter
```

- Create and switch to a new branch:

```bash
git checkout -b feature/your-feature-name
# or
git checkout -b fix/your-fix-name
# or
git checkout -b doc/your-doc-improvements
```

### 4. Make Changes

Keep changes relevant to your branch’s purpose.

### 5. Commit Changes

This repository requires signed commit, so please before continuing, take a look at [Signing Commits - GitHub Docs](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits).

- Stage your changes:

```bash
git add .
```

- Write a meaningful commit message:

```bash
git commit -m "Add feature/bug-fix description"
```

### 6. Push to Your Fork

Push your branch to your forked repository:

```bash
git push origin feature/your-feature-name
```

### 7. Submit a Pull Request

- Navigate to your forked repository on GitHub.
- Click the Pull Request button.
- Select the base repository and compare across forks.
- Add a detailed description explaining your changes.

## Code of Conduct

By participating in this project, you agree to follow our [Code of Conduct](./CODE_OF_CONDUCT.md).

## Review Process

Pull requests will be reviewed by maintainers.
Feedback may be provided; be prepared to make changes if requested.
Once approved, your contribution will be merged into the main branch.

Thank you for helping improve Node Module Starter! 🎉
Loading

0 comments on commit 7e3de26

Please sign in to comment.