What to Contribute
If you have an idea for blog post or page that you think might be useful to people navigating their way to a Ph.D. in CS, we’d love to hear about it.
Some things to keep in mind:
- Despite the existence and usefulness of school rankings, the site does not promote some schools over others.
- The site loves hearing about your first-hand experience getting, advising, and having a Ph.D. in CS.
- The site loves hearing about useful/relevant data about Ph.D. and analysis thereof.
All contribution are made under the Creative Commons Attribution 4.0 International License.
Providing Links to Resources
If you have a resources (e.g., a blog post you’ve written) that you think would be useful, please submit a pull request that adds the appropriate link, and we will take a look.
How to Contribute
There are two mechanisms you can use to help us improve this web site:
- Is something broken? Submit a bug report.
- Is it something you can fix? Submit a pull request.
- Do you want to write an article or blog post? Read on:
Contributing an Article or Blog Post
We welcome contributions to the site. If you have an idea for an article, please send email to email@example.com to discuss what you’re interested in writing and how it would fit into the site.
Once that’s done the mechanics are like this:
- Clone a copy of the site on github: https://github.com/mycsphd/mycsphd.github.io.
- Populate it with interesting advice and information based on your experience, expertise, or research. Write in markdown.
- If you need images (we love graphs!) put the images in
assets/imgand name them in a short descriptive way.
- Commit and push everything.
We have found hackmd.io to be very useful for providing feedback on articles. It can pull from github and is free for collaboration. Setup a collabortive version of your article:
- Visit hackmd.io and create an account.
- Click on the three dots on the right of the green button to “import a file from GitHub”.
- Click “authorize more repos”. It will take you to GitHub. Give hackmd access to your fork of mycsphd.io.
- Select your file, and click ‘Pull’.
- Click “apply all changes”
You can edit your article in WYSIWYG. It also provides a commenting mechanism, which is very handy.
You can preview your work locally. The
Makefile will start a local web
server that serves the site. Your draft article will (confusingly, perhaps)
appear in the Blog.
Let firstname.lastname@example.org know that your article is ready and we’ll take a look. Once everything looks good, we’ll have you generate a pull request to merge it into the site.