Thank you for investing your time in contributing to the GLD project! Your contribution will improve the GLD project .:sparkles:
Read our Code of Conduct to keep our community approachable and respectful.
In this guide you will get an overview of the contribution workflow from opening an issue, creating a pull request (PR), reviewing, to merging the PR.
To get an overview of the project, read the README.
Check to see what types of contributions we accept before making changes. Some of them don't even require writing a single line of code ✨.
If you spot a problem in any of the harmonization codes or documents, search if an issue already exists. If a related issue does not exist, you can open a new issue using a relevant issue form.
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 or to send as an email if the issue is restricted.
Click Edit at right upper side of the page of any document or code 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.
Local changes (changes directly on the GLD repository) are only open to World Bank users. Additionally, only members of the World Bank GitHub organization (which you join via eService Request) are eligible to be added to the GLD team. Only the GLD team can make changes locally
However, please feel free to propose your changes in a PR and the focal point will assess the contribution and accept it or reject it accordingly.
The simplest way is to just tell us about your experience. Did you find everything you needed? Were you able to run all the files? Was the process comprehensible to you? Feedback on your experience interacting with the repository helps us improve it, so please feel free to get in touch with the GLD Focal Point.
In addition to reporting on your experience, as you run and use the harmonization you may spot errors in the code. We harmonize conscientiously and run our harmonization through a set of checks, yet some errors we cannot spot. If you spot any of those please either write to the GLD Focal Point or, even better, raise an issue we can all see, if possible with a link to particular section of the code in question.
Finally, if you are working on a project that needs a harmonization, please feel free to do it to our standard, we’d be excited to host your contribution. You may find the data dictionary on our site as well as the GLD harmonization template. You may fork our repository, run through the quality checks and create a pull request and we will review it to add it to the collection.
When you're finished with the changes, create a pull request, also known as a PR.
- Fill the "Ready for review" template 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, The GLD team will review your proposal. We may ask questions or request for 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.
- Please use the general guidance for self-review to minimize back and forth with the reviewers.
Congratulations 🎉🎉 The GLD team thanks you ✨.
If you don't yet know how to file a pull request, read GitHub's document about it.
Make your pull request be the addition of a single file to the
issues directory of this project. Name the file
with the same name as your GitHub userid, with .md appended to the
end. For example, for the user generic-user, the full path to the file
would be issues/generic-user.md.
Put the following in the file:
[date]
I hereby agree to the terms of the Contribution guidelines and code of conduct of the community.
I furthermore declare that I am authorized and able to make this
agreement and sign this declaration.
Signed,
[your name]
https://github.com/[your github userid]
Replace the bracketed text as follows:
[date]with today's date, in the unambiguous numeric formYYYY-MM-DD.[your name]with your name.[your github userid]with your GitHub userid.
If the output is different from above, let us know.
That's it!
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
Send an Email to the team
-----------------
Send an email to the GLD team
at [[email protected]](mailto:[email protected]),
with the subject "Acknowledgment of Contribution Rules" and the following body:
I submitted a pull request to indicate agreement to code of conduct and contribution guidelines.
Signed,
[Your Name] https://github.com/[your github userid] [your address] [your phone number]
Replace the bracketed text as follows:
* `[your name]` with your name.
* `[your github userid]` with your GitHub userid.
* `[your address]` with a physical mailing address at which you can be
contacted.
* `[your phone number]` with a phone number at which you can be contacted.
The information on this page has been adapted from the GLD contribution template .