How to Contribute

We’re excited you’re interested in contributing to the DxDevRel Guide! Whether you’re fixing a typo, writing a new page, suggesting improvements, or adding helpful resources, your input helps improve this resource for the entire developer relations community.

This guide walks you through the steps for making your first (or next!) contribution.

---

🛠️ Getting Started

To contribute:

1. Fork this repository to your GitHub account.

2. Clone your fork to your local machine:

   git clone https://github.com/yourusername/dx-devrel-guide.git
   

3. Install the Mintlify CLI:

   npm i -g mintlify
   

4. Create a new branch to work on an issue or feature:

   git checkout -b feat/your-feature-name
   

5. Run the project locally to view and test your changes:

   mintlify dev
   

---

✍️ Writing and Editing Content

When adding or updating content:

• Create new files using this naming format: lowercase-with-dashes.mdx
• Start every file with a title in the frontmatter:

---
title: Developer Relations Strategy
---

## Introduction
...

• Use clear, concise, and inclusive language
• Feel free to share real-world examples or anecdotes where relevant

---

✅ Submitting Your Contribution

Once you’re done making your changes:

1. Commit your changes with a clear commit message:

   git commit -m "feat: add section on community engagement"
   

2. Push your changes:

   git push origin feat/your-feature-name
   

3. Open a Pull Request (PR) on the GitHub repository.

   • Link it to a relevant issue if applicable.
   • Keep pull requests focused and easy to review.

---

🧾 Commit Message Guidelines

To keep things organized, we follow Conventional Commits:

Type	Description
feat	New features or pages
fix	Bug fixes or typo corrections
docs	Documentation-only changes
refactor	Refactoring without behavior changes
chore	Routine tasks (e.g., config updates)
test	Adding or updating tests

---

💬 Need Help?

If you’re unsure where to start:

• Browse our open issues
• Ask questions in our Discord community
• Or reach out to the maintainers via GitHub Discussions

---

🙏 Thank You!

Your contributions, wheather big or small, make a real difference. This guide is built by and for the community, and we deeply appreciate your time, insight, and collaboration.