Contributing
If you’re interested in supporting the Hub’s development and are familiar with Markdown, read on to learn how to contribute to the project.
Contributions are very welcome and appreciated. Be sure to review CONTRIBUTING.md before getting started with your contribution!
Project Structure
This is not the entire project structure, but it’s the most important part of the project structure which we recommend you limit your contributions to.
Directorypublic (any image used on the hub is found here)
- …
Directorysrc
Directoryassets (our official logos are here)
- …
Directorycontent
Directorydocs
Directoryazure/ (Azure exams are found here)
- …
Directoryblog/ (Blog posts are found here)
- …
Directorydynamics/ (Dynamics exams are found here)
- …
Directoryguide/ (The guide is found here)
- …
Directorymicrosoft365/ (Microsoft 365 exams are found here)
- …
Directoryoffice/ (Office exams are found here)
- …
Directorypower/ (Power Platform exams are found here)
- …
Directorysecurity/ (Security exams are found here)
- …
Directoryvouchers/ (voucher offers are found here)
- …
- 404.mdx
- contributing.mdx
- index.mdx
- wiki.mdx (This is the Wiki collection)
- astro.config.mjs (Astro configuration file)
- package.json (Project dependencies)
Web-only Contribution
While this method is limited in terms of what you should contribute, you can still contribute to the project by adding new text content on existing pages, fixing typos, or improving existing text content.
Requirements
- Good understanding of Markdown
- Basic understanding of how to use GitHub
- A brain and patience
- A computer and an internet connection
Setting up the project
-
Fork the project to your GitHub account.
-
Navigate to the file you want to edit in the GitHub repository of your fork.
-
Click on the edit icon on the top right corner of the file.
-
Make your changes in the editor.
-
After making changes, scroll down to the bottom of the page and write a short description of the changes you made.
-
Create a pull request to the main repository. Wait for the maintainers to review your pull request.
-
Celebrate when your pull request is merged!
IDE-based Contribution
This method is more advanced and allows you to contribute to the project in a more flexible way. You can add new pages, edit existing pages, and add new components to the Hub. This also allows you to preview your changes locally before submitting a pull request.
Requirements
- Basic understanding of Markdown and Starlight Components
- Basic understanding of how to use GitHub
- A brain and patience
- A computer and an internet connection
- A code editor like VSCode or a GitHub’s Codespace
Setting up the project
-
Fork the project, then clone it to your local machine. If you don’t know what any of this means then refer to this video here.
-
Install any package manager you want to use. We recommend pnpm due to it’s performant and small size. You can install pnpm by visiting the official website and following the instructions.
-
Install the dependencies by running the following command in the terminal:
-
Run the project by running the following command in the terminal:
-
Open your browser and navigate to
http://localhost:4321
to see the project running. -
After making changes, make sure you’re not breaking anything by previewing your changes locally. If there are no errors, commit your changes and push them to your forked repository.
-
Create a pull request to the main repository. Wait for the maintainers to review your pull request.
-
Celebrate when your pull request is merged!
Where to begin?
If you’re new to the project, you can start by fixing typos, adding new studying resources, or improving existing guides. This will help you get familiar with the project structure and the way content is written.
Here’s a bunch of resources that will help you understand how the Hub works better: