Skip to content

Latest commit

 

History

History
87 lines (57 loc) · 1.79 KB

CONTRIBUTING.md

File metadata and controls

87 lines (57 loc) · 1.79 KB

Contributing Guide

We welcome contributions! Please follow these guidelines:

Getting Started

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/rajibola/human-regex.git
  3. Install dependencies: npm install
  4. Create a feature branch: git checkout -b feature/your-feature

Development Process

  • Write tests for new features
  • Follow existing code style
  • Update documentation when adding new features
  • Keep commits atomic and well-described

Code Style

  • 2-space indentation
  • Prefer named exports
  • JSDoc comments for public methods
  • Follow Airbnb JavaScript Style Guide

Testing

Run tests with:

npm test

Submitting PRs

  1. Rebase your branch onto main.
  2. Ensure all tests pass.
  3. Update CHANGELOG.md.
  4. Open a pull request with a clear description.
  5. Reference related issues.

Reporting Issues

When reporting an issue, please use the GitHub issues template and include the following information:

  1. Package version.
  2. Node.js version.
  3. Error messages.
  4. Reproduction steps.

3. CODE_OF_CONDUCT.md

# Contributor Covenant Code of Conduct

## Our Pledge

We pledge to foster an open, welcoming, diverse, inclusive, and healthy community.

## Our Standards

Examples of positive behavior:

- Using welcoming language
- Respecting differing viewpoints
- Graceful acceptance of constructive criticism
- Focusing on community benefit

Unacceptable behavior:

- Harassment, discrimination, or violence
- Trolling or insulting comments
- Publishing others' private information
- Other unethical conduct

## Enforcement

Violations may result in temporary/permanent bans. Report to [rajibola1997@gmail.com].

Full text: [Contributor Covenant 2.1](https://www.contributor-covenant.org/version/2/1/code_of_conduct/)

[]: # (END)

[]