Skip to content

Latest commit

 

History

History
42 lines (22 loc) · 1.78 KB

CONTRIBUTING.md

File metadata and controls

42 lines (22 loc) · 1.78 KB

Introduction

Welcome to ExamArchive!

First off, thank you for considering contributing to ExamArchive. It's people like you that make ExamArchive such a great tool.

It's good to have some guidelines

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.

Explain what kinds of contributions you are looking for.

Keep an open mind! Improving test coverage, bug triaging, or writing simple features are all examples of helpful contributions that mean less work for you.

Your First Contribution

Help people who are new to your project understand where they can be most helpful. This is also a good time to let people know if you follow a label convention for flagging beginner issues.

Unsure where to begin contributing? You can start by looking through these beginner and help-wanted issues: Beginner issues - issues which should only require a few lines of code, and a test or two. Help wanted issues - issues that should be a bit more involved than beginner issues. Both issue lists are sorted by total number of comments. While not perfect, number of comments is a reasonable proxy for impact a given change will have.

Getting started

A quick walkthrough of how to submit a contribution.

  • We track all the issues using our public kanban github project board.

For contributing:

  1. Create your own fork of the code
  2. Do the changes in your fork
  3. If you like the change and think the project could use it:

Code, commit message and labeling conventions

These sections are not necessary, but can help streamline the contributions you receive.