Giter VIP home page Giter VIP logo

alx_test_suite's Introduction

ALX TEST SUITE

DESCRIPTION

  • This is a set of testing scripts(edge case tests) for ALX SE pair programming projects.
  • This suite is tested on Ubuntu 20.04 WSL.

FEATURES

  • Runs a checker on your compiled code and displays OK if you have the expected output.
  • Displays command to be executed before it starts.
  • Displays number of OK outputs at the end and total number of commands ran.
  • Check only specific tasks instead of whole suite at once.

USAGE

TODO: DOCS For TDD_project Comming Soon

FEEDBACK AND ISSUES

We welcome any feedback, suggestions, or bug reports related to the test cases in this repository. If you encounter any issues or have ideas for improvement, please open an issue on the repository's issue tracker. We appreciate your contributions in making this repository a valuable resource for students engaged in pair programming projects.

HOW TO CONTRIBUTE

Step 1: Clone repository

git clone https://github.com/Fuzzworth/alx_test_suite.git

Step 2: Create a local branch

git checkout -b enhancement/<local_branch_name>

or

git branch enhancement/<local_branch_name>
git checkout enhancement/<local_branch_name>

Step 3: Make your updates

  • DO NOT MODIFY ANY OF THE FILES IN THE DIRECTORIES

Step 4: Commit using the below template

Follow instructions for template here: Original post

An easy way to get this config using a single command:

printf "# Title: Summary, imperative, start upper case, don't end with a period\n# No more than 50 chars. #### 50 chars is here:  #\n\n# Remember blank line between title and body.\n\n# Body: Explain *what* and *why* (not *how*). Include task ID (Jira issue).\n# Wrap at 72 chars. ################################## which is here:  #\n\n\n# At the end: Include Co-authored-by for all contributors. \n# Include at least one empty line before it. Format: \n# Co-authored-by: name <[email protected]>\n#\n# How to Write a Git Commit Message:\n# https://chris.beams.io/posts/git-commit/\n#\n# 1. Separate subject from body with a blank line\n# 2. Limit the subject line to 50 characters\n# 3. Capitalize the subject line\n# 4. Do not end the subject line with a period\n# 5. Use the imperative mood in the subject line\n# 6. Wrap the body at 72 characters\n# 7. Use the body to explain what and why vs. how\n" > ~/.gitmessage && git config --global commit.template ~/.gitmessage

then,

git config commit.template ~/.gitmessage

then,

git commit

Do not use!!!

git commit -m "message"

Remove "#" from start of line to uncomment line

Title: Summary, imperative, start upper case, don't end with a period
# No more than 50 chars. #### 50 chars is here:  #

# Remember blank line between title and body.

Body: Explain *what* and *why* (not *how*). Include task ID (Jira issue).
# Wrap at 72 chars. ################################## which is here:  #

# At the end: Include Co-authored-by for all contributors. 
# Include at least one empty line before it. Format: 
Co-authored-by: name <[email protected]>
#
# How to Write a Git Commit Message:
# https://chris.beams.io/posts/git-commit/
#
# 1. Separate subject from body with a blank line
# 2. Limit the subject line to 50 characters
# 3. Capitalize the subject line
# 4. Do not end the subject line with a period
# 5. Use the imperative mood in the subject line
# 6. Wrap the body at 72 characters
# 7. Use the body to explain what and why vs. how

# Please enter the commit message for your changes. Lines starting
# with '#' will be ignored, and an empty message aborts the commit.
#
# On branch master
# Your branch is up to date with 'origin/main'.
#
# Changes to be committed:
#       new file:   installation.md
#

Step 5: Push your branch

git push --set-upstream origin enhancement/<local_branch_name>

Step 6: Compare and Pull Request to merge your changes to main on this Github repo

Currently Three Approvals are required to merge a branch in a pull request to main... God Speed and happy coding everyone!

Before Approving a Pull request check to see it doesn't break our hard work.

If all is well Approve the request but if it is not Well leave a comment... links below

LAST UPDATE: 27 MAY 2023

alx_test_suite's People

Contributors

baribor avatar elfadili-ae avatar fuzzworth avatar hasbi-sabah avatar omotomiwa26 avatar sheko100 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.