Skip to content

Latest commit

 

History

History
58 lines (42 loc) · 3.57 KB

CONTRIBUTING.md

File metadata and controls

58 lines (42 loc) · 3.57 KB
Raw

Welcome to our contributing guide

This project is founded and currently being developed by FHICT GDT2022 group-9 students, but perhaps others would like to help in the near future, as this is an open source project. In this page, you will be given an overview of the contribution workflow from opening an issue to merging you changes.

New contributor guide

To get an overview of the project, read the README. Here are some resources to help you get started with open source contributions:

Getting started

Issues

Create a new issue

If you find an issue with the repository or have a feature request, search if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue form.

Solve an issue

Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. See Labels for more information. As a general rule. If you find an issue to work on, you are welcome to open a PR with a fix.

Make Changes

Versions

--

Prerequisites

--

Make changes locally

-- No info currently --

Pull Request

Work from a feature branch

Your local changes should either be on a forked repo that you have cloned locally or on a feature branch. When your changes have been made you should create a PR and link the PR to issue if you are solving one

Testing

-- currently no testing conventions --

Review

Before your changes will get submitted to the it should be reviewed by at least one of the other team members.

  • We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
  • As you update your PR and apply changes, mark each conversation as resolved.
  • If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.

Your PR is merged!!! 🥳🥳

For members

The project is being developed with an Agile process. We work in sprints of two weeks.

Branch name

Each branch should be related to a issue or user story. The branch should be named according to the feature you are willing to implement:

  • <type>[optional scope]: <description>

Commit Policy

  • Commits must have describing titles.