Skip to content

Latest commit

 

History

History
99 lines (68 loc) · 6.65 KB

Contribution.md

File metadata and controls

99 lines (68 loc) · 6.65 KB
Raw

Welcome to TCET Open Source contributing guide

Thank you for investing your time in contributing to our project!

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, and merging the PR.

New contributor guide

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

Getting started

To navigate our codebase with confidence, see our Github Repository

Issues

Asking to work on 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. For contributing comment on that specific issue that you want to work on it and we will assign that specific issue to you. Please remember only start working on the issue after it is assigned to you.

Create a new issue

If you find a bug or want to add any sort of feature in the repository , search if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue form. Please note that the name of the issue title should be relevant and should give an idea about what you are working on.

Make Changes

Make changes in the UI

Click Make a contribution at the bottom of erp-backend to make small changes such as a typo, sentence fix, or a broken link. This takes you to the .md file where you can make your changes and create a pull request for a review.

Make changes locally

  1. External Contributors , Fork the repository
  • Using GitHub Desktop:
  • Using the command line:
    • Fork the repo, so that you can make your changes without affecting the original project until you're ready to merge them.
  • After forking clone the forked repository
  • Switch from main branch to development branch in your cloned repository
    • To switch to development write command git remote add upstream <link of original repo> and git fetch upstream in the terminal
  • To install node modules use command npm ci
  • Switch to Development Branch and create a working branch for each issue.
  • To create a branch use command git branch <name of the branch>
    • NOTE: The name of the branch should in the format of -> Issue number-name of the issue (eg: 50-create_CRUD_for_infra_model)
  • Then from the development branch move to the branch created by using command git checkout <branch name>
  • All changes on the code should be done on your specific branch
  • Test your changes: After making your changes, it is crucial to thoroughly test them to ensure they function as intended and do not introduce any new bugs. Run any relevant tests or simulations and verify that the modified code performs correctly.
  • Before pushing the changes sync fork in the forked repo and pull the changes before pushing
  • After pushing go to the forked repository and press contribute and make a pull request
  1. Internal Contributors, Clone the Repository   git clone -b development https://github.com/tcet-opensource/erp-backend.git
  • To install node modules use command npm ci
  • Switch to Development Branch and create a working branch for each issue.
  • To create a branch use command git branch <name of the branch>
    • NOTE: The name of the branch should in the format of -> Issue number-name of the issue (eg: 50-create_CRUD_for_infra_model)
  • Then from the development branch move to the branch created by using command git checkout <branch name>
  • All changes on the code should be done on your specific branch
  • Test your changes: After making your changes, it is crucial to thoroughly test them to ensure they function as intended and do not introduce any new bugs. Run any relevant tests or simulations and verify that the modified code performs correctly.

Commit your changes

  • Stage your changes: Use the git add command to stage the modified files for the commit. This marks the changes as ready to be included in the next commit. git add <file1> <file2> ... or git add .
  • Commit your changes: Create a commit to record your modifications with a meaningful commit message. This helps in tracking and understanding the purpose of the changes. git commit -m "relevant info of the change"
  • Before pushing the changes on the repository always remember to pull the code to avoid any merge conflicts git pull origin development
  • try pushing the code on the development branch and not directly to the main branch

Push your Changes

  • After committing your changes, you push them to a remote repository (in this case, your forked repository on GitHub) using the git push command. Pushing your changes uploads them to the remote repository, making them visible to others and allowing you to share your work. git push origin <branch name>

Pull Request

When you're finished with the changes, create a pull request, also known as a PR.

  • Don't forget to link PR to issue by using "#" issue number , if you are solving one.
  • Once you submit your PR, a team member will review your proposal. We may ask questions or request additional information.
  • 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 merge conflicts to help you resolve merge conflicts and other issues.

Your PR is merged!

Congratulations , The TCET Open Source team thanks you.