EDITING.md

Editing Open English WordNet

This document contains guidelines for making changes to Open English WordNet and fixing issues using GitHub and the English WordNet Editor (EWE)

You should take the following steps to implement a change in the resource

Fork the repository

This is not necessary if you have the rights to change the repository directly. You only need to do this once

Choose the 'fork' option in the top right hand corner of the screen. Follow the instructions and you will have a new version of the repository at https://github.com/EXAMPLE/english-wordnet where EXAMPLE is your GitHub ID.

Choose an issue

Choose one of the issues from the issue list. If there is not an issue yet, please first report an issue before making any changes.

Create a branch for the issue

Create a new branch for the issue which would normally be called issue-XXX where XXX is the issue number.

On the command line

git checkout -b issue-XXX master

Using GitHub Desktop

Implement the change using EWE

The preferred editing tool for this resource is EWE. The lastest version can be downloaded from the releases page at https://github.com/jmccrae/ewe/releases

EWE is a menu-driven application. Please choose the relevant changes and save the results before making a pull request

Commit the changes

You should verify and commit the changes made to the files. Please provide a readable title for the change and include a GitHub keyword to close the issue.

Command line

git commit -a

Using GitHub Desktop

Push the changes and create a merge request

Push the changes to GitHub using the 'publish' option on GitHub desktop or by the command

git push

Then create a new pull request on GitHub.com