Skip to content

Files

Latest commit

 

History

History
104 lines (73 loc) · 2.58 KB

CONTRIBUTING.md

File metadata and controls

104 lines (73 loc) · 2.58 KB

Contributing to degache.js

Thank you for your interest in contributing to degache.js! This document provides guidelines and instructions for contributing to this project.

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. Please be respectful and considerate of others.

How to Contribute

Reporting Bugs

If you find a bug, please create an issue on our GitHub repository with the following information:

  • A clear, descriptive title
  • Steps to reproduce the bug
  • Expected behavior
  • Actual behavior
  • Screenshots (if applicable)
  • Environment details (OS, browser, Node.js version, etc.)

Suggesting Features

We welcome feature suggestions! To suggest a feature:

  1. Check if the feature has already been suggested or implemented
  2. Create an issue with a clear description of the feature and its benefits
  3. If possible, include examples of how the feature would be used

Pull Requests

  1. Fork the repository
  2. Create a new branch from main with a descriptive name (feature/new-validation, fix/phone-number-bug)
  3. Make your changes
  4. Add or update tests as necessary
  5. Ensure all tests pass
  6. Update documentation if needed
  7. Submit a pull request

Pull Request Guidelines

  • Follow the existing code style
  • Include tests for new features
  • Update documentation for any changes
  • Keep pull requests focused on a single change
  • Reference related issues in the pull request description

Development Setup

  1. Clone the repository

    git clone https://github.com/KhalidRouissi1/degachejs.git
cd degachejs

  2. Install dependencies

    npm install

  3. Build the project

    npm run build

  4. Run tests

    npm test

Coding Standards

  • Use TypeScript for all code
  • Follow the existing code style
  • Write clear, descriptive comments
  • Include JSDoc comments for all public APIs
  • Write tests for all new functionality

Testing

  • Write unit tests for all new functionality
  • Ensure all tests pass before submitting a pull request
  • Run tests with npm test

Documentation

  • Update the README.md file with any new features or changes
  • Include examples for new functionality
  • Document all public APIs with JSDoc comments

Release Process

The maintainers will handle the release process, including:

  1. Updating the version number
  2. Creating a changelog
  3. Publishing to npm
  4. Creating a GitHub release

Questions?

If you have any questions about contributing, please open an issue or contact the maintainers.

Thank you for contributing to degache.js! 🇹🇳