Skip to content

Commit cb2c5aa

Browse files
Bump version to 2.0.24 and add standard files (#68)
* Bump version to 2.0.24 and add standard files * Update deps * Okay --------- Co-authored-by: Denis Tokarev <[email protected]>
1 parent 8a63b3b commit cb2c5aa

File tree

7 files changed

+1804
-1426
lines changed

7 files changed

+1804
-1426
lines changed

.npmignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ docs/
77
lint/
88
node_modules/
99
src/*
10+
dist/utils
1011

1112
# Configuration files
1213
.editorconfig

.npmrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
legacy-peer-deps=true

CODE_OF_CONDUCT.md

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
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, religion, or sexual identity and orientation.
6+
7+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
8+
9+
## Our Standards
10+
11+
Examples of behavior that contributes to a positive environment for our community include:
12+
13+
* Demonstrating empathy and kindness toward other people
14+
* Being respectful of differing opinions, viewpoints, and experiences
15+
* Giving and gracefully accepting constructive feedback
16+
* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
17+
* Focusing on what is best not just for us as individuals, but for the overall community
18+
19+
Examples of unacceptable behavior include:
20+
21+
* The use of sexualized language or imagery, and sexual attention or advances of any kind
22+
* Trolling, insulting or derogatory comments, and personal or political attacks
23+
* Public or private harassment
24+
* Publishing others’ private information, such as a physical or email address, without their explicit permission
25+
* Other conduct which could reasonably be considered inappropriate in a professional setting
26+
27+
## Enforcement Responsibilities
28+
29+
Community leaders 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.
30+
31+
Community leaders 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.
32+
33+
## Scope
34+
35+
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.
36+
37+
## Enforcement
38+
39+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [INSERT CONTACT METHOD]. All complaints will be reviewed and investigated promptly and fairly.
40+
41+
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
42+
43+
## Enforcement Guidelines
44+
45+
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
46+
47+
### 1. Correction
48+
49+
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
50+
51+
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
52+
53+
### 2. Warning
54+
55+
**Community Impact**: A violation through a single incident or series of actions.
56+
57+
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
58+
59+
### 3. Temporary Ban
60+
61+
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
62+
63+
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
64+
65+
### 4. Permanent Ban
66+
67+
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
68+
69+
**Consequence**: A permanent ban from any sort of public interaction within the community.
70+
71+
## Attribution
72+
73+
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.html.
74+
75+
Community Impact Guidelines were inspired by [Mozilla’s code of conduct enforcement ladder](https://github.com/mozilla/diversity).
76+
77+
For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
78+
79+
[homepage]: https://www.contributor-covenant.org

CONTRIBUTING.md

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
# Contributing to async-wait-until
2+
3+
First off, thank you for considering contributing to async-wait-until! It's people like you that make this project better for everyone.
4+
5+
## Table of Contents
6+
7+
- [Code of Conduct](#code-of-conduct)
8+
- [Getting Started](#getting-started)
9+
- [Pull Requests](#pull-requests)
10+
- [Development Workflow](#development-workflow)
11+
- [Coding Style](#coding-style)
12+
- [Testing](#testing)
13+
- [Reporting Bugs](#reporting-bugs)
14+
- [Suggesting Features](#suggesting-features)
15+
- [License](#license)
16+
17+
## Code of Conduct
18+
19+
This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to the project maintainers.
20+
21+
## Getting Started
22+
23+
### Prerequisites
24+
25+
- Node.js (version specified in package.json)
26+
- npm or yarn
27+
28+
### Setup
29+
30+
1. Fork the repository
31+
2. Clone your fork: `git clone https://github.com/YOUR-USERNAME/async-wait-until.git`
32+
3. Navigate to the project directory: `cd async-wait-until`
33+
4. Install dependencies: `npm install` or `yarn install`
34+
5. Create a new branch for your changes: `git checkout -b feature/your-feature-name`
35+
36+
## Pull Requests
37+
38+
1. Ensure your code passes all tests
39+
2. Update documentation if necessary
40+
3. Include relevant tests for your changes
41+
4. Ensure your commits are well-formatted and descriptive
42+
5. Submit a pull request to the `main` branch
43+
44+
### Pull Request Process
45+
46+
1. Update the README.md with details of changes if applicable
47+
2. Increase the version numbers in package.json and other relevant files following [Semantic Versioning](https://semver.org/)
48+
3. The PR will be merged once it has been reviewed and approved by a maintainer
49+
50+
## Development Workflow
51+
52+
1. Make your changes
53+
2. Run tests: `npm test` or `yarn test`
54+
3. Lint your code: `npm run lint` or `yarn lint`
55+
4. Fix any issues before committing
56+
57+
## Coding Style
58+
59+
- This project uses ESLint and Prettier for code formatting
60+
- Follow the existing code style
61+
- Use descriptive variable and function names
62+
- Add comments for complex logic
63+
64+
## Testing
65+
66+
- Write tests for new features and bug fixes
67+
- Ensure all tests pass before submitting a PR
68+
- Aim for good test coverage
69+
70+
## Reporting Bugs
71+
72+
When reporting bugs, please include:
73+
74+
- A clear and descriptive title
75+
- Steps to reproduce the issue
76+
- Expected behavior
77+
- Actual behavior
78+
- Environment information (OS, Node.js version, etc.)
79+
- Any relevant logs or screenshots
80+
81+
## Suggesting Features
82+
83+
When suggesting features:
84+
85+
- Clearly describe the feature and its benefits
86+
- Provide examples of how it would be used
87+
- Indicate if you're willing to help implement it
88+
89+
## License
90+
91+
By contributing, you agree that your contributions will be licensed under the same license as the project.
92+
93+
Thank you for contributing to async-wait-until!

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ A lightweight, zero-dependency library for waiting asynchronously until a specif
77
![MIT License](https://img.shields.io/npm/l/async-wait-until)
88
[![Maintainability](https://api.codeclimate.com/v1/badges/2a967399786c0d306247/maintainability)](https://codeclimate.com/github/devlato/async-wait-until/maintainability)
99

10+
## 📖 Detailed Documentation
11+
12+
For detailed documentation, visit [https://devlato.github.io/async-wait-until/](https://devlato.github.io/async-wait-until/)
13+
1014
---
1115

1216
## 🚀 Installation
@@ -122,3 +126,11 @@ Contributions are welcome! To contribute:
122126
- **Generate Docs:** `npm run docs`
123127

124128
---
129+
130+
## 📝 Links
131+
132+
- [License](./LICENSE)
133+
- [Detailed Documentation](https://devlato.github.io/async-wait-until/)
134+
- [Changelog](./CHANGELOG.md) - Track version updates and changes
135+
- [Contributing Guidelines](./CONTRIBUTING.md) - How to contribute to the project
136+
- [Code of Conduct](./CODE_OF_CONDUCT.md) - Community standards and expectations

0 commit comments

Comments
 (0)