Skip to content

Latest commit

 

History

History
33 lines (26 loc) · 2.99 KB

CONTRIBUTING.md

File metadata and controls

33 lines (26 loc) · 2.99 KB
Raw

How to give feedback

First off, thank you for considering giving feedback or contributing to Data for Development Impact. Any and all feedback to refine this book further or to make this text as comprehensive as possible is appreciated. Following these guidelines helps communicate any errors we may have overlooked, any concepts that may seem little vague or difficult to comprehend or any topics that we have missed to include.

If you are familiar with how GitHub works, please feel free to submit issues for any section you don't understand or submit a pull request with any additions you want to make.

Feedback through Email

While our preference is to receive feedback through GitHub you are always welcome to submit your feedback via our email [email protected]

Feedback through GitHub

If you notice any errors in text or if you need further clarification for any sentence/concept/section that you think is not exhaustively dealt within the book, you can do so by creating an issue. You can read issues submitted by other users or create a new issue here.

For example, if you think the example the authors have used to explain a particular research design is too convoluted to understand, creating an issue is useful for you to provide us the feedback that we should use a simpler example to explain the research design. Please read already existing issues to check whether someone else has made the same suggestion or reported the same error before creating a new issue.

GitHub Issue Submission Format

For us to be able to search through the feedback we will organize all issues in a specific format. If you do not know how to follow all steps in the bullet point below, then please feel free to post the issue anyways, but we will edit the issue so that it follows our format.

  1. Go to the issues tab on the D4DI repository.
  2. Search the already posted issues to see if the feedback you are about to give is already posted,
  3. If your feedback has not already been brought up, please press the green New Issue button to post a new issue.
  4. Write your title on the format Ch #: description where # is the chapter number and description is a short description of the issue, and apply the corresponding chapter label
  5. Please link in the issue to the file in the repo you are commenting on. If you are referencing a specific line please either link to the specific line in the repo or just link to the file and specify the row number you are referencing

Pull Request Process

  1. Fork this repository if you want to make your contributions directly in the files.
  2. Make your edits in the develop branch in your fork and then create your pull request towards the worldbank/d4di:develop branch. We do not accept pull requests towards the master branch
  3. The Repo Maintainer for worldbank/d4di will review the pull request and provide comments if necessary.