Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
59 lines (41 loc) · 2.68 KB

CONTRIBUTING.md

File metadata and controls

59 lines (41 loc) · 2.68 KB

Contributing to Rubber Ducky 🦆

Thank you for considering contributing to Rubber Ducky! We welcome contributions from the community to help make this a better tool for structured problem-solving.

Code of Conduct

While we don't have a formal Code of Conduct document yet, please be respectful and constructive in all interactions within the project community (issues, pull requests, etc.). We aim to foster a positive and welcoming environment.

How Can I Contribute?

Reporting Bugs

  • Check the existing GitHub Issues to see if the bug has already been reported.
  • If not, create a new issue. Please include:
    • A clear and descriptive title.
    • Steps to reproduce the bug.
    • What you expected to happen.
    • What actually happened.
    • Your browser and operating system (if relevant).
    • Screenshots (if helpful).

Suggesting Enhancements

  • Check the existing GitHub Issues to see if your enhancement idea has already been suggested.
  • If not, create a new issue. Please include:
    • A clear and descriptive title.
    • A detailed description of the proposed enhancement and why it would be valuable.
    • Any potential implementation ideas (optional).
    • Use the "enhancement" label if possible.

Pull Requests

We welcome pull requests!

  1. Fork the repository to your own GitHub account.
  2. Clone your fork locally (git clone https://github.com/DevChthonic/rubberducky.git).
  3. Create a new branch for your changes (git checkout -b feature/your-feature-name or bugfix/issue-description).
  4. Make your changes. Focus on the specific bug fix or feature.
  5. Test your changes locally to ensure they work as expected and don't break existing functionality.
  6. Commit your changes with clear and descriptive commit messages.
  7. Push your branch to your fork (git push origin feature/your-feature-name).
  8. Open a Pull Request on the original repository.
    • Provide a clear title and description of your changes.
    • Reference any relevant issues (e.g., "Fixes #123").

Current Focus: While all contributions are welcome, current development is primarily focused on improving the UI/UX design. Contributions in this area are particularly appreciated!

Development Setup

Rubber Ducky is currently a client-side web application built with HTML, CSS and JavaScript. To run it locally:

  1. Clone the repository.
  2. Open the index.html file.

Questions?

If you have questions about contributing or using the tool, feel free to open an issue on the GitHub Issues page.