Skip to content

Welcome to d4dtools contributing guide

Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on openkfw.github.io/d4dtools ✨.

You can contribute to the d4dtools content and site in several ways. Our small, but mighty 💪 docs team is maintaining this repo; to preserve our bandwidth, off topic conversations will be closed.

📣 Discussions

Discussions are where we have conversations.

If you'd like help troubleshooting a doc's PR you're working on, have a great new idea, or want to share something amazing you've learned in our docs, join us in discussions.

🐞 Issues

Issues are used to track tasks that contributors can help with. If an issue has a triage label, we haven't reviewed it yet, and you shouldn't begin work on it.

If you've found something in the content or the website that should be updated, search open issues to see if someone else has reported the same thing. If it's something new, open an issue here. We'll use the issue to have a conversation about the problem you want to fix.

Create a new issue

If you spot a problem with the docs, search if an issue already exists. If a related issue doesn't exist, you can open a new issue.

Solve an issue

Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. See Labels for more information. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.

Make Changes in the github UI

Click Make a contribution at the top of any page to make small changes such as a typo, sentence fix, or a broken link. This takes you to the .md file where you can make your changes and create a pull request for a review.

Commit your update

Commit the changes once you are happy with them. Don't forget to self-review to speed up the review process ⚡.

🛠 Pull requests

A pull request is a way to suggest changes in our repository. When we merge those changes, they should be deployed to the live site almost immediately. 🌍

So when you're finished with the changes, create a pull request, also known as a PR.

  • Fill the description so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
  • Don't forget to link PR to issue if you are solving one.
  • Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your PR, a d4dtools team member will review your proposal. We may ask questions or request additional information.
  • We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
  • As you update your PR and apply changes, mark each conversation as resolved.
  • If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.

Your PR is merged!

Congratulations 🎉🎉 The d4dtools team thanks you ✨.

Once your PR is merged, your contributions will be publicly visible on the d4dtools docs.

Now you are part of the d4dtools community. Thank you for your contributions! We look forward to working with you to make our project even better.

Adding new fact sheets

If you would like to contribute a new fact sheet, please make sure that it is complete and properly formatted. All fact sheets should include a title, a brief introduction, and a list of bullet points or numbered points outlining the key information.

  • Before contributing, please take a moment to check that your contribution fits within the scope of the project. We recommend you check out the already existing collection of fact sheets, before starting a new one. Our project is a collection of fact sheets, so we are looking for contributions that are factual, well-researched, and unbiased. Ideally you open an issue to discuss if the fact sheet is fitting. We might be already working on one but did not quite finish it.
  • Please make sure to follow proper citation guidelines when including information from external sources. All sources should be properly cited in the text and listed in a references section at the end of the fact sheet.
  • When submitting a contribution, please include a brief description of the changes you have made. This will help us understand the purpose of your contribution and ensure that it is properly reviewed. This should happen through a pull request as described just above.

Attribution

These contribution guidelines are adapted from the contribution guidelines for Github docs, available online on the github.