Development Contribution Guide
This guide is targeted towards developers interested in contributing to the development of Mintmade widgets. You are assumed to have a strong understanding of JavaScript and web development principles.
Step 1: Request Access to the Repository
The first step is to gain access to the repository. You can request access by sending an email to hello@mintmade.io. Be sure to include your GitHub username in your email and a brief explanation of why you want access to the repository.
Step 2: Clone the Repository
Once you've been granted access, you can clone the repository. Open your terminal, navigate to the directory where you want to clone the repository, and run the following command:
This will create a local copy of the project on your machine.
Step 3: Navigate into the Project Directory
After cloning the repository, navigate into the project directory:
Step 4: Install Dependencies
The project has some dependencies which need to be installed before you can start developing. Install them by running:
Step 5: Start the Development Server
This project uses webpack for building and running a development server. You can start the server by running:
This will start the development server, and any changes you make to the source code will trigger a rebuild. The changes should then be reflected in your browser.
Step 6: Make Your Changes
You can now start making changes to the project. Whether you're fixing bugs, adding new features, or improving the documentation, your contributions are welcome.
Step 7: Push Changes to the Repository
Once you've made your changes, you should commit them and push them to the repository. Remember to write clear and concise commit messages that explain what changes you've made and why.
Note: If you're adding a new feature or making significant changes, it's a good idea to create a new branch and make your changes there. This keeps the main branch clean and allows other developers to easily review your changes.
Step 8: Create a Merge Request
After you've pushed your changes, the final step is to create a merge request. This is a request to merge your changes into the main branch of the project. In your merge request, explain what changes you've made, why you've made them, and how they improve the project.
Step 9: Review and Merging
After submitting your merge request, it will be reviewed by other members of the project. They may give you feedback and ask you to make changes. Once your merge request is approved, your changes will be merged into the main branch of the project.
By following these steps, you can contribute to the development of Mintmade widgets. Thank you for your interest in improving this project!
Last updated