What to contribute

As we stated in the announcement, we would like to make this blog a forum for the people who are interested in natural language processing (NLP) from the newbies to the guru, and to disseminate the information about the latest updates in NLP world and also how-to or how-not-to analyze text as data.

To serve this goal, we would like to ask those who have a say on NLP to get involved in our blog as contributors of blog post. In particular, we are particularly interested in the following types of contributions:

  1. Tutorials for softwares and packages
  2. Use case of NLP softwares
  3. Benchmarking of different methods/softwares

How to contribute

This blog is served by blogdown, and all contents are generated from markdown files. For our contributors, we would like to ask you to prepare an md file. Due to the current setup of the blog, an rmd has to be pre-compiled to an md file before sending to us (regarding the difference between md and rmd, please refer here).

Markdown syntax

If you are not familiar with the markdown syntax, please refer to online resources on it.


Sending us your blog post

At the moment, our blog offers two methods to sending us your contributions

  1. Through a pull request (PR) to this repository (Recommended)
  2. Sending us a markdown file as an email attachment

Method 1: PR method

The recommended way to contribute to our blog is to send your blog post as a pull request for our blog repository (link). If you are not familiar with the git/github workflow, please read this article.

The followings are the steps:

  1. Create a local copy of the repository
  2. Create your own branch
  3. Write your own post as a markdown file using the template (found in templates folder.)
  4. Save the file under contents/posts.
  5. Make a commit to your branch with your markdown file
  6. Push your commit
  7. Create a pull request here

Once you create a pull request, the editorial process will be openly conducted within the pull request. Our editors will check the contents and may make some edits. If we think necessary, we may ask you to edit the post. In that case, you pull the update to your branch, edit the file, commit the changes, and then push the update to the repository. When you and our editors agree the contents, the pull request is merged and your article is published.

Method 2: Sending us a markdown file

You can contribute to our blog with this way.

  1. Download the template file here
  2. Write your own post using the template
  3. Send the file to us

When we receive the file, we create a pull request and notify you. From there, the editorial process will be the same as the pull request method (in the end you have to have a github account).

Inclusion of codes in your post

You, of course, include the code in your post. The syntax is something like:

      x <- rnorm(100)
      y <- rnorm(100)
      plot(x, y)

We accept the post in the normal markdown format (not r-markdown), which means that if you want to include the output from your code, you need to put them in the markdown file. If the code is written in R, probably the easiest way is to knit the file (c.f. https://stackoverflow.com/questions/31914161/how-to-convert-rmd-into-md-in-r-studio).

Inclusion of images

You can show images saved in the static/img folder. The syntax to include image is found in the blog-post template.

Additional tips

  1. Make your post accessible to NLP beginners (esp. if your post is a tutorial).
  2. Be nice to other software developers or users of other softwares you are not particularly fond of.
comments powered by Disqus