Skip to content

Added More Specific Expectations in Project Template #350

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

Merged
merged 1 commit into from
Oct 8, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 16 additions & 10 deletions templates/PROJECT_ARTICLE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,38 @@
---
title: <Sample Program> in Every Language
title: {SAMPLE PROGRAM} in Every Language
layout: default
date: YYYY-MM-DD
last-modified: YYYY-MM-DD
featured-image: <name of featured image file in assets folder>
tags: [<a list of tags>]
featured-image: {FEATURED IMAGE NAME}
tags: [{PROJECT NAME}]
authors:
- <author username from _data/authors.yml>
- {AUTHOR USERNAME FROM _data/authors.yml}
---

[Insert intro sentence here]
{INTRO SENTENCE}

## Description

[Insert description of project here]
{PROJECT DESCRIPTION}

## Requirements

[Outline program requirements here]
{PROJECT REQUIREMENTS}

```shell
./sample-program.lang sample_input
```

## Testing

[Outline a comprehensive set of tests here]
| Description | {EXAMPLE INPUT COLUMN} | Output |
| ----------- | ---------------------- | ------------------ |
| {EXAMPLE 1} | {EXAMPLE INPUT 1} | {EXAMPLE OUTPUT 1} |

## Articles

{% include article_list.md collection=site.categories.[name of project] % }
{% include article_list.md collection=site.categories.{PROJECT NAME} %}

## Further Reading

- [List useful links here]
- {USEFUL REFERENCES}