Contributing to Dirent 🐾

April 6, 2025 · View on GitHub

Dirent is an open source project and we love to receive contributions from our community -- you! There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests, or writing code which can be incorporated into Dirent.

For example, we are looking for contributions which

  1. Improve portability of code developed for Unix/Linux to Microsoft Windows,
  2. Make Dirent easier to use and/or more useful for programmers working on Microsoft Windows platform, or
  3. Remove compiler warnings or fix bugs.

How to Suggest a Feature 🙋

We use GitHub to host code, to track issues and to discuss about Dirent. If you would like to suggest a feature, then feel free to open discussion at GitHub.

How to Report a Bug 👾

If you have trouble using Dirent, then try to repeat the problem with the latest version from GitHub. If the problem persist, then feel free to open an issue at GitHub.

How to Submit a Fix or an Enhancement 🔧

Step 1: Fork the Repository 🍴

Start by forking the repository. You can do this by clicking the "Fork" button in the upper right corner of the repository page. This will create a copy of the repository in your GitHub account.

Step 2: Clone Your Fork 📥

Clone your newly created fork of the repository to your local machine as

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

where your-username is your username at GitHub.

Step 3: Create a New Branch 🌿

Create a new branch for the issue or feature you are working on as

git checkout -b "feature"

where feature is a concise name for the branch, e.g. "username-patch".

Step 4: Submitting Changes 🚀

After you have made changes to the codebase, stage your changes as

git add .

Commit changes with a message as

git commit -m "A brief summary of the commit"

Step 5: Create a Pull Request 🌟

Go to your forked repository on GitHub and click on the "New Pull Request" button. This will open a new pull request to the original repository.

Thank you for your contribution! ❤️