Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Review process for new languages / big updates #117

Open
heatherleaf opened this issue Jan 3, 2019 · 4 comments
Open

Review process for new languages / big updates #117

heatherleaf opened this issue Jan 3, 2019 · 4 comments

Comments

@heatherleaf
Copy link
Member

When someone issues a new Pull Request, there should be an open and transparent review process before it's accepted. I suggest it consists of the following:

  1. There must be good documentation: a README and code comments
  2. There must be test cases: at least a simple parallel corpus or treebank with 10-20 sentences
  3. The PR should be advertised on the mailing list, and people get time to comment on it
  4. It should be reviewed by at least 2 people

This is if the PR is a new language or a big update to an existing language. If there is small update (e.g., bug fix or additions to a lexicon), the process can be quicker.

@heatherleaf
Copy link
Member Author

If the PR is about a new functor, the process must be even more strict, because functors influence so many languages.

@johnjcamilleri
Copy link
Member

Good suggestions Peter. These should be placed somewhere official, such as the main README, so that new contributors know what to expect (and for us to refer to).

On this note, I am wary of using PRs a bit too superfluously. Specifically, updating a README like can surely just be committed directly into main by someone with write access.

@heatherleaf
Copy link
Member Author

On this note, I am wary of using PRs a bit too superfluously. Specifically, updating a README like can surely just be committed directly into main by someone with write access.

Of course. I mainly meant that large changes (new languages or big additions or substantial modification) should be PRs, so that it's possible to discuss.

@odanoburu
Copy link
Contributor

so that it's possible to discuss.

not only discuss, but also find out about the changes!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants