expand_less

Contribution Guide

Note From Developer

Greetings, fellow dreamforkers! Erm, I mean developers.

As you navigate through this documentation or will be exploring it, you'll likely notice the fact that Dreamfork is the creation of a full-stack developer who comfortably identifies as a junior. Embracing transparency, it's essential to acknowledge that my experience is still in its growth phase, and as a result, the framework may not be flawless.

Dreamfork is a project born out of a desire to create something functional and to breathe life into a concept. It's not perfect, and I'm okay with that. I've crafted this tool with the hope that it will serve educational purposes and be suitable for simple projects.

I urge you to consider using Dreamfork for learning and exploration rather than in critical business solutions. In the world of business, where a team of experienced developers is often a necessity, this junior developer's creation might not be the ideal fit.

Introduction

Dreamfork is a project created "by developers, for developers." We believe in the power of community collaboration and welcome contributions from anyone interested in making the framework better. Whether you're a seasoned developer or just getting started, your input is valuable to us.

This section provides you with the information you need to contribute to Dreamfork Framework effectively. Whether you want to report a bug, suggest a new feature, or even submit code changes, we appreciate and encourage your involvement. Let's build something great together!

Report An Issue

If you've encountered any issues with the Dreamfork framework, we encourage you to report them by opening an issue on our Github repository. Your feedback is crucial in helping us improve the framework.

When reporting an issue, please provide as much detail as possible:

  • Description: Clearly describe the issue you're facing.
  • Reproduction Steps: Include steps to reproduce the problem.
  • Expected Behavior: Describe what you expected to happen.
  • Actual Behavior: Explain what actually occurred.
  • Environment Details: Specify the framework version, PHP version, and any other relevant details.

The more information you provide, the easier it is for us to identify and address the issue promptly. We appreciate your efforts in making Dreamfork better for everyone. Click here to open a new issue.

Suggest a New Feature

If you have a feature in mind that you'd like to see implemented in the Dreamfork framework, we welcome your suggestions! Opening a feature request on our Github repository allows you to share your ideas and contribute to the framework's growth.

When suggesting a new feature, provide the following details:

  • Feature Description: Clearly describe the new functionality you're proposing.
  • Scope of Tasks: Outline the tasks or requirements the feature should fulfill.
  • Use Cases: Describe potential use cases or scenarios where the feature would be beneficial.
  • Dependencies: Mention any existing features or components that the new feature might depend on.

Your input is valuable, and we appreciate your proactive involvement in shaping the future of Dreamfork. Click here to open a new feature request.

Contribute To Dreamfork

Dreamfork is a collaborative project, and we encourage developers to actively contribute by forking the project on GitHub. Follow these steps to create your variations and enhancements:

Start by forking the Dreamfork repository to your GitHub account. This creates a copy of the project under your account.

Clone the forked repository to your local machine. 

                                
                                    

                                        git clone https://github.com/your-username/dreamfork.git

Before making changes, create a new branch for your enhancements or bug fixes. 

                                
                                    

                                        git checkout -b feature-or-fix-branch

Implement your changes and ensure they align with the project's coding standards. Commit your changes with clear and concise messages. 

                                
                                    

                                        git commit -m "Description of changes"

Push your changes to your forked repository. 

                                
                                    

                                        git push origin feature-or-fix-branch

Create a pull request from your branch to the main Dreamfork repository. Provide a detailed description of your changes.

We appreciate your contributions! We'll review your pull request, and if everything aligns with the project's goals, we'll merge it into the framework.