Skip to content
This repository was archived by the owner on Nov 18, 2020. It is now read-only.

CONTRIBUTING.md

Latest commit

 

History

History
62 lines (43 loc) · 3.41 KB

CONTRIBUTING.md

File metadata and controls

62 lines (43 loc) · 3.41 KB
Raw

How To Contribute

Welcome, and thank you for your interest in contributing to the TeacherFund api!

There are many ways to contribute, beyond writing code. The goal of this document is to provide a high-level overview of how you can get involved.

Reporting Issues

We want to hear about any problems with the website. Whether it be a visual bug, a functional issue (e.g. links don't work, server errors when donating or logging in, etc.), or just a suggestion to make things more maintainable, please log an issue in this repository.

Look For an Existing Issue

Before you create a new issue, please do a search in open issues to see if the issue or feature request has already been filed.

If you find your issue already exists, make relevant comments and add your reaction. Use a reaction in place of a "+1" comment:

  • 👍 - upvote
  • 👎 - downvote

Writing Good Bug Reports and Feature Requests

File a single issue per problem and feature request. Do not enumerate multiple bugs or feature requests in the same issue.

Do not add your issue as a comment to an existing issue unless it's for the identical input. Many issues look similar, but have different causes.

These would be very helpful to include:

  • Reproducible steps (1... 2... 3...) that cause the issue
  • What you expected to see, versus what you actually saw
  • Images, animations, or a link to a video showing the issue occurring

Writing Code

If you are interested in writing code to fix issues, read the below to understand our project structure and set up your development environment.

In order to avoid duplicate work and to save you from wasting time, please comment in an open issue your intention to code out the resolution to that issue. If it isn't obvious how that issue will be solved, outline what you plan to do to make sure it's in line with the maintainers' vision for the project.

The website is written in Typescript using Koa.

Directory Structure

  • src
    • All source files for api (models, db connection, types, routes)
  • tests
    • All tests for controllers

Local Development Environment

  • Install Node.js and NPM >= 8.x
  • Fork this repository, clone it locally, and keep it in sync by following the instructions here
  • Install dependencies by running npm install in the project directory
  • Start a local mysql server: mysql.server start learn more here
  • mysql -u root
  • create database teacherfund;
  • exit When done, fire up the server with npm run dev, and hit the backend at url: http://localhost:3000/

Opening a Pull Request

Commit any code changes to a branch (e.g. fix/donationController or feature/donationRoute).

When you've finished making changes and committed the changes into your branch, you can open a pull request. Please reference the issue you have solved in your pull request.

Coding Standards

  • Code should pass linting by Standard. Run npm run lint to confirm there are no linting errors.
  • Bugfixes should be accompanied by tests to avoid regression

Thank You!

Your contributions to open source, large or small, make projects like this possible. Thank you for taking the time to contribute.