Skip to content

Latest commit

 

History

History
67 lines (50 loc) · 1.87 KB

CONTRIBUTING.md

File metadata and controls

67 lines (50 loc) · 1.87 KB

Contributing to DuckDuckJS

Thank you for considering contributing to DuckDuckJS! Your contributions are valuable and help make this project better for everyone.

Getting Started

  1. Fork the Repository: Click on the "Fork" button at the top right corner of this repo.
  2. Clone Your Fork: 
    git clone https://github.com/your-username/duckduckjs.git
  3. Create a Branch: 
    git checkout -b your-feature-branch
  4. Install Dependencies: 
    npm install
  5. Make Changes: Implement your changes or fixes.

Code Guidelines

  • Follow the existing code style using ESLint and Prettier.
  • Use descriptive commit messages.
  • Ensure your code is easy to understand.
  • Avoid introducing breaking changes unless necessary.

Submitting Your Changes

  1. Commit Your Changes: 
    git add .
git commit -m "description short but meaningfull"
  2. Push to Your Fork: 
    git push origin your-feature-branch
  3. Open a Pull Request (PR): Go to the main repository and click on "New Pull Request."
  4. Provide Context: Clearly describe the changes, referencing any issues your PR addresses.

Reporting Issues

If you encounter a bug or have a feature request, please open an issue with the following information:

  • A clear and descriptive title.
  • Steps to reproduce (if applicable).
  • Screenshots or error messages (if available).

Running Tests

Make sure all tests pass before submitting your changes:

npm test

Code of Conduct

By participating in this project, you agree to follow our Code of Conduct.

Acknowledgments

Thank you for your contributions! Every bit of help is appreciated and makes DuckDuckJS better for all users.

If you have any questions, feel free to reach out by opening a discussion or commenting on an issue!