During Google Seaon of Docs (GSoD) 2020, I work on the Wordnet Structure project of Global Wordnet Association, to help work out a detailed introduction of the structure of wordnet.
My work distributes in two Github repositories:
In gwadoc, my main job is to help develop the second half of all the relations in the Wordnet Documentation, I have made below contributions:
- the Rebuild the sidenav bar pull request to help make a side navigation for the Wordnet Documentation so that users can scroll up and down the docs more conveniently. Since this page is automatically generated with templates, the content in the side navigation can also get automatically updated by running the
build.py
script. - the Create Overview section pull request to add a Overview section at the beginning of the wordnet docs to give users a brief introduction of the basics of wordnet. See issue#54 for the discussion.
- the Update Domain / In Domain and sub members pul request to update the docs for Domain-related relations in wordnet, such as write descriptions, examples and tests for the relations. See issue#34 for the discussion.
- the Move Domain related changes pull request aims to move all changes to a new pull request as the old Update Domain / In Domain and sub members is in conflict with the master branch according to the structure changes of this repository.
- the Update Role and its sub members pull request updates the docs of Role-related relations in wordnet. See issue#38 for the discussion.
- the Update Co-role groups and the last three pull request updates the docs of co-role-related relations and the last three remaining relations in wordnet. See issue#48 for the discussion.
In wn repository, which is a python module for building new wordnets, my main job is to help develop a guide to introduce the structure of wordnet. I have made below contributions:
- the Draft of guides/wordnet pull request to help develop a guide of the structure of wordnet about the details of relations between words, senses and synsets, as well as the difference of synset relations and sense relations. See issue#37 for the discussion.
After GSoD, I will stay in this project and contribute a Chinese version of the wordnet documentation to the gwadoc repository.
- understand the code in the project
- understand the concepts in wordnet from the very beginning
- describe a technical problem in an accurate way
- learn to write in ReStructuredText
- learn to communicate more clearly and efficiently in an international team
- learn more CSS and Javascript tricks
- learn to use Sphinx
GSoD 2020 records my first time to contribute to an open source project, my first pull request in Github, my first bonding to a great community.
I would like to thank my mentor Francis Bond and Michael Wayne Goodman and other members in the community to generously share their expertise with me, I would also like to thank other two writers Glory and Rohitesh's help, and thank Google to create such a great opportunity for us to gather together to make docs better.
Thank you, you were fantastic!