Skip to content

Latest commit

 

History

History
60 lines (42 loc) · 2.43 KB

CONTRIBUTING.md

File metadata and controls

60 lines (42 loc) · 2.43 KB
Raw

Contributing to Teamwork Time Report

Welcome to Teamwork Time Report, thank you for investing your time in contributing to our project! Below are the guidelines to help you understand how to contribute to this project. Please checkout our README file to become acquainted with this project.

Table of Contents

Code of Conduct

Please note that this project has adopted a Code of Conduct, and by participating in this project you agree to abide by its terms. Please find the full contents of the Code of Conduct by clicking here.

Creating an Issue ✏️

  1. Please be sure there is not an open issue in the Issues Section of the repository you are working on.
  2. If this is a bug, please include the steps necessary to reproduce the issue, and create a reproducible test case and include it in a .md file within the pull request titled BUG_FIX.md.
  3. For feature requests, please share a description of the new feature, why the new feature improves the project, and how you would implement it.
  4. Please share links to the corresponding GitHub documentation.

Please follow the steps below:

  1. Fork the repository
  2. Clone the fork to your local machine.
  • Replace with the name of the account you forked to and with the repository name you forked.
 git clone https://github.com/<your account name>/<repository name>.git
  cd <repository name>
 npm install
  1. Build the project to make sure the local setup is work as expected
 npm build
  1. Run the project
 npm run start

Submitting a Pull Request 🚀

  1. Create a new local branch
  • Replace with your new branches name.
 git branch <branch name>
  1. Make changes in your branch and push them to your fork with detailed commit messages.
  2. Submit a pull request from your branch to the master branch on the ci-teamwork repository.
  • Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.