Working with Mintting means engaging with an open-source repository hosted on GitHub. This guide walks you through the practical steps of getting a local copy of the project, exploring what is there, and participating in the community through issues and pull requests.Documentation Index
Fetch the complete documentation index at: https://mintlify.com/taskian/mintting/llms.txt
Use this file to discover all available pages before exploring further.
Clone and explore the repository
The first step is getting the source code onto your machine so you can read through it, experiment, and understand how the project is structured.Clone the repository
Run the following command in your terminal to download a local copy of Mintting:This creates a
mintting/ directory in your current location containing the full repository history.Navigate into the project
Move into the cloned directory to start exploring:From here you can browse the files, read the
README.md, and look through any existing documentation or configuration.Open an issue
If you find a bug, have a question, or want to suggest an improvement, opening an issue on GitHub is the right place to start.Search for existing issues
Before opening a new issue, search the existing issues to see if someone has already reported the same thing. A quick search saves everyone time.
Open a new issue
If no existing issue matches, click New issue on the repository’s Issues tab. Give your issue a clear, descriptive title and fill in as much detail as you can: what you expected to happen, what actually happened, and any steps to reproduce the problem.
Submit a pull request
If you want to contribute a change directly — whether it is a documentation fix, a small improvement, or a new feature — follow these steps.Fork the repository
On GitHub, click Fork to create your own copy of the Mintting repository under your account. You will make your changes in your fork.
Create a branch
Create a new branch for your change rather than working directly on
main. Use a name that describes what the branch does:Make your changes
Edit the files you need to change. Keep each pull request focused on a single concern — smaller, targeted changes are easier to review and faster to merge.
Push and open a pull request
Push your branch to your fork and then open a pull request against the main Mintting repository. Write a clear description explaining what you changed and why.
Community norms and contributing etiquette
Mintting follows the norms common to open-source projects hosted on GitHub. When participating, keep the following in mind:- Be respectful. Everyone contributing is volunteering their time. Assume good intent and communicate constructively.
- Be specific. Vague issues are hard to act on. Include context, reproduction steps, and relevant details.
- Keep pull requests small. Large, sprawling changes are difficult to review. Break your work into focused, reviewable pieces where possible.
- Follow existing conventions. Match the code style, file structure, and naming patterns you see in the project rather than introducing your own preferences.
- Be patient. Maintainers may have limited availability. If you do not hear back within a reasonable time, a polite follow-up comment on the issue or pull request is appropriate.