/PR_Tool

Primary LanguageHTMLGNU General Public License v3.0GPL-3.0

Contributors Forks Stargazers Issues GUN 3.0 License

📌 About The Project

This is a PR tool for sunbirddcim/test_automation.
This project is aim to better PR management and faster/easier PR creation.

📌 Usage

  • Create a new pull request
    1. Create a new branch for your PR (ex. TMD-12345).
    2. Click New Pull Request button.
    3. Click the upload area to upload the refine test test. (Note that your filename must match the corresponding branch name ex. TMD-12345.txt)
    4. For the first upload, you must fill the Reviewers, Assignees and Labels.
    5. Select the base branch
    6. Check the PR branch, title, body, reviewers, assignees and labels again.
    7. Click Create Pull Request button.
  • Please follow the below guidelines if you would like to report a bug:

    1. Use the GitHub issue search — check if the issue has already been reported.

    2. Check if the issue has been fixed — try to reproduce it using the latest main or development branch in the repository.

    3. Isolate the problem — create a reduced test case and a live example.

    Example:

    Short and descriptive example bug report title

    A summary of the issue and the browser/OS environment in which it occurs. If suitable, include the steps required to reproduce the bug.

    1. This is the first step
    2. This is the second step
    3. Further steps, etc.

    <url> - a link to the reduced test case

    Any other information you want to share that is relevant to the issue being reported. This might include the lines of code that you have identified as causing the bug, and potential solutions (and your opinions on their merits).

  • Follow this process if you'd like your work considered for inclusion in the project

  1. Fork the project, clone your fork, and configure the remotes:

    # Clone your fork of the repo into the current directory
    git clone https://github.com/Ming119/PR_Tool
    # Navigate to the newly cloned directory
    cd PR_Tool
    # Assign the original repo to a remote called "upstream"
    git remote add upstream https://github.com/Ming119/PR_Tool
  2. If you cloned a while ago, get the latest changes from upstream:

    git checkout <dev-branch>
    git pull upstream <dev-branch>
  3. Create a new topic branch (off the main project development branch) to contain your feature, change, or fix:

    git checkout -b <topic-branch-name>
  4. Locally merge (or rebase) the upstream development branch into your topic branch:

    git pull [--rebase] upstream <dev-branch>
  5. Push your topic branch up to your fork:

    git push origin <topic-branch-name>
  6. Open a Pull Request with a clear title and description.

IMPORTANT: By submitting a patch, you agree to allow us to license your work under the same license as that used by PR_Tool