Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
120 lines (84 loc) · 3.2 KB

CONTRIBUTING.md

File metadata and controls

120 lines (84 loc) · 3.2 KB

Contributing to HelloJS

🎉 Thank you for your interest in contributing to HelloJS!
Contributions of all kinds — code, documentation, bug reports, and ideas — help make this project better.

📚 Help and Support

If you are having problems implementing HelloJS, you might find your answers already discussed. Please see:

Want to discuss your implementations?

If you are experiencing a bug in HelloJS or would like the library to support other services and features, please create a new issue.

💡 Ways You Can Contribute

You don’t need to write code to contribute — there are many ways to help:

  • Report Issues → Found a bug? Please open an issue.
  • Improve Documentation → Fix typos, clarify explanations, or add missing steps in README.md or CONTRIBUTING.md.
  • Suggest Features → Have an idea? Share it in a new issue for discussion.
  • Answer Questions → Help others on StackOverflow or in the Gitter chat.
  • Contribute Code → Work on bugs or features listed in the issue tracker.

⚙️ Setting Up the Project Locally

  1. Fork the Repository
    Click “Fork” on the top right of the HelloJS GitHub repo.

  2. Clone Your Fork

    git clone https://github.com/<your-username>/hello.js.git
cd hello.js

  3. Install Dependencies:
    Make sure you have Node.js installed, then run:

    npm install

  4. Run Tests:
    To confirm everything works:

    npm test

✏️ Making Changes

  1. Create a New Branch:

    git checkout -b my-change

  2. Make Your Edits:
    Update code or documentation as needed.

  3. Test Your Changes:
    Run tests to ensure nothing breaks:

    npm test

  4. Commit Your Changes:

    git add .
git commit -m "docs: improve contributing guide"

📤 Submitting Your Contribution

  1. Push Your Branch:

    git push origin my-change

  2. Open a Pull Request:

    • Go to your fork on GitHub.
    • Click “Compare & pull request.”
    • In the PR description, explain:
      • What you changed
      • Why it’s helpful (e.g., “makes contributing easier for beginners”)

🗣️ Communication & Support

✅ Contribution Checklist

  • Forked and cloned the repo
  • Installed dependencies (npm install)
  • Created a new branch
  • Made clear, focused changes
  • Ran tests successfully
  • Opened a PR with a good description

Thank you for making HelloJS better!
This guide is designed to help beginners and experienced contributors alike.