Skip to content

Latest commit

 

History

History
73 lines (47 loc) · 5.17 KB

CONTRIBUTING.md

File metadata and controls

73 lines (47 loc) · 5.17 KB

How to Contribute

This repo is a volunteer effort. All newcomers to git and GitHub are welcome!

Not sure what GitHub is? Watch this excellent video for a quick primer or take this quick GitHub course.

Next, read this step-by-step guide to contributing on GitHub.

Thanks!

<3 The Langara CS Club


Table of contents

Code of Conduct

This project and everyone participating in it is governed by the Langara Student Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to the Langara CS Club on Discord.

How Can I Contribute

Reporting Issues

Before creating bug reports, please check this list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible.

Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.

Before Submitting An Issue

Search the repo to see if the problem has already been reported. If it has and the issue is still open, add a comment to the existing issue instead of opening a new one.

How Do I Submit A (Good) Issue

Bugs are tracked as GitHub issues. Create an issue and provide the following information.

Explain the problem and include additional details to help maintainers reproduce the problem:

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as many details as possible. When listing steps, don't just say what you did, but explain how you did it. For example, if you moved the cursor to the end of a line, explain if you used the mouse, or a keyboard shortcut and if so which one?
  • Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples (if applicable). If you're providing snippets in the issue, use Markdown code blocks.
  • Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
  • Explain which behavior you expected to see instead and why.
  • Include screenshots and animated GIFs which show you following the described steps and clearly demonstrate the problem. You can use this tool to record GIFs on macOS and Windows, and this tool or this tool on Linux.

Suggesting Enhancements

Before Submitting An Enhancement Suggestion

Search the repo to see if the enhancement has already been suggested. If it has and the issue is still open, add a comment to the existing issue instead of opening a new one.

How Do I Submit A (Good) Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues. Create an issue and provide the following information:

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Provide specific examples to demonstrate the steps. Include copy/pasteable snippets (if applicable) which you use in those examples, as Markdown code blocks.
  • Describe the current behavior and explain which behavior you expected to see instead and why.
  • Include screenshots and animated GIFs (if applicable) which help you demonstrate the steps or point out the part of REPL which the suggestion is related to. You can use this tool to record GIFs on macOS and Windows, and this tool or this tool on Linux.
  • Explain why this enhancement would be useful to most REPL users.
  • List some other sources where this enhancement exists if it helps.