Skip to content

Commit 0ec73df

Browse files
addon-owneraddon-owner
committed
Merge branch 'release/v0.1.0'
2 parents 198ed0c + 81f891c commit 0ec73df

42 files changed

Lines changed: 9536 additions & 0 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.gitignore‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
.DS_Store
2+
.env
3+
.env.*
4+
.idea
5+
.output
6+
addon
7+
*.log
8+
/.vscode/
9+
/docs/.vitepress/cache
10+
coverage
11+
dist
12+
package
13+
node_modules
14+
TODOs.md
15+
stats.html
16+
.tool-versions
17+
.cache
18+
*-stats.txt

‎.prettierignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
node_modules/
2+
dist/
3+
build/

‎.prettierrc‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"semi": true,
3+
"trailingComma": "es5",
4+
"singleQuote": false,
5+
"printWidth": 120,
6+
"tabWidth": 4,
7+
"useTabs": false,
8+
"bracketSpacing": false,
9+
"arrowParens": "avoid"
10+
}

‎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+
<addonbonedev@gmail.com>.
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: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
<!--
2+
CONTRIBUTING.md
3+
Guidelines for contributing to the @adnbn/browser project.
4+
-->
5+
6+
# Contributing to @adnbn/browser
7+
8+
> **Project Vision:** Our goal is to deliver a comprehensive TypeScript-based promise wrapper for the entire Chrome Extensions API surface (Manifest V2 & V3). Contributions to extend coverage and refine existing implementations are highly valued.
9+
>
10+
> _Thank you for taking the time to contribute to this project!_
11+
12+
This document outlines the process for contributing, reporting issues, and submitting patches. By participating, you agree to abide by the project’s [Code of Conduct](CODE_OF_CONDUCT.md).
13+
14+
## Table of Contents
15+
16+
1. [Reporting Bugs](#reporting-bugs)
17+
2. [Suggesting Enhancements](#suggesting-enhancements)
18+
3. [Development Setup](#development-setup)
19+
4. [Submitting a Pull Request](#submitting-a-pull-request)
20+
5. [Code Style](#code-style)
21+
6. [Commit Messages](#commit-messages)
22+
7. [Code of Conduct](#code-of-conduct)
23+
8. [License](#license)
24+
25+
---
26+
27+
## Reporting Bugs
28+
29+
To file a clear and actionable bug report:
30+
31+
1. Search existing issues to see if the bug has already been reported.
32+
2. If not, open a new issue and include:
33+
- A descriptive title.
34+
- Steps to reproduce the problem.
35+
- Expected vs. actual behavior.
36+
- Environment details (OS, browser, Node.js/npm versions).
37+
- Any relevant stack traces or screenshots.
38+
39+
## Suggesting Enhancements
40+
41+
For feature requests or enhancements:
42+
43+
1. Check open issues for similar proposals.
44+
2. Open a new issue with:
45+
- A clear use case or motivation.
46+
- Proposed API or code examples (if available).
47+
- Any alternatives you considered.
48+
49+
## Development Setup
50+
51+
1. Fork the repository:
52+
`git clone git@github.com:addonbone/browser.git`
53+
2. Install dependencies:
54+
```bash
55+
cd browser
56+
npm install
57+
```
58+
3. Available scripts:
59+
- `npm run format` — format code with Prettier
60+
- `npm run build` — build the project with tsup
61+
62+
## Submitting a Pull Request
63+
64+
1. Create a feature branch:
65+
`git checkout -b feature/name`
66+
2. Make your changes in TypeScript under `src/`.
67+
3. Ensure formatting passes:
68+
```bash
69+
npm run format
70+
```
71+
4. Run the build to confirm no errors:
72+
```bash
73+
npm run build
74+
```
75+
5. Commit changes using [Conventional Commits](https://www.conventionalcommits.org/):
76+
```
77+
feat(core): add new API method for X
78+
```
79+
6. Push to your fork and open a Pull Request against the `main` branch.
80+
7. Provide a clear title and description, referencing related issues (e.g., `Closes #123`).
81+
82+
## Code Style
83+
84+
- Language: **TypeScript**
85+
- Formatting: **Prettier**
86+
87+
Please run `npm run format` before submitting code.
88+
89+
## Commit Messages
90+
91+
We follow the [Conventional Commits](https://www.conventionalcommits.org/) specification:
92+
93+
```
94+
<type>[optional scope]: <description>
95+
```
96+
97+
Common types:
98+
99+
- `feat`: a new feature
100+
- `fix`: a bug fix
101+
- `docs`: documentation only changes
102+
- `style`: formatting, missing semicolons, etc
103+
- `refactor`: code change that neither fixes a bug nor adds a feature
104+
- `test`: adding missing tests or correcting existing tests
105+
- `chore`: updating build tasks, package manager configs, etc
106+
107+
## Code of Conduct
108+
109+
Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md) in all interactions.
110+
111+
## License
112+
113+
By contributing, you agree that your changes will be licensed under the project’s MIT License.

0 commit comments

Comments
 (0)