Skip to content

Latest commit

 

History

History
58 lines (39 loc) · 2.36 KB

CONTRIBUTING.md

File metadata and controls

58 lines (39 loc) · 2.36 KB

Contributing to Dooders Projects

First off, thank you for considering contributing to the projects! Your help and support are greatly appreciated.

How to Contribute

Reporting Bugs

If you find a bug in any of the projects, please create an issue in the respective project's GitHub repository. Include as much detail as possible to help understand and reproduce the issue.

Steps to report a bug:

  1. Go to the project's repository on GitHub.
  2. Click on the "Issues" tab.
  3. Click "New Issue".
  4. Provide a descriptive title and detailed description of the bug.
  5. Include any relevant logs, screenshots, or steps to reproduce the issue.

Suggesting Enhancements

Suggestions are welcome for new features or improvements to any project. If you have an idea, please create an issue in the respective project's repository with the following information:

Steps to suggest an enhancement:

  1. Go to the project's repository on GitHub.
  2. Click on the "Issues" tab.
  3. Click "New Issue".
  4. Provide a descriptive title and detailed description of the enhancement.
  5. Explain why this enhancement would be beneficial.

Contributing Code

If you would like to contribute code to one of the projects, please follow these steps:

  1. Fork the repository to your own GitHub account.
  2. Clone the forked repository to your local machine.
  3. Create a new branch for your changes (git checkout -b feature/your-feature-name).
  4. Make your changes.
  5. Commit your changes with clear and descriptive commit messages (git commit -m "Add new feature")
  6. Push your changes to your forked repository (git push origin feature/your-feature-name)
  7. Open a pull request in the original repository:
    • Go to the original repository on GitHub.
    • Click on the "Pull Requests" tab.
    • Click "New Pull Request".
    • Select your branch from your forked repository.
    • Provide a clear and descriptive title and description for your pull request.

Documentation

Improvements to documentation are always welcome. If you find a typo, want to clarify a section, or have a new example to add, please submit a pull request.

Testing

If you are submitting code, please include tests to verify your changes. This helps ensure that the code remains stable and functional. Describe how to run the tests in the pull request.

Thank You!

Thank you for considering contributing to these projects.