se-homework-2b

CSE 510 Project

https://github.com/sn-18/se-homework-2b

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 3 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (16.7%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

CSE 510 Project

Basic Info
  • Host: GitHub
  • Owner: SN-18
  • License: mit
  • Language: Python
  • Default Branch: main
  • Size: 84 KB
Statistics
  • Stars: 1
  • Watchers: 2
  • Forks: 1
  • Open Issues: 0
  • Releases: 2
Created over 4 years ago · Last pushed over 4 years ago
Metadata Files
Readme Contributing License Code of conduct Citation

README.md

Software Engineering: Homework-2b

Description

The primary purpose of this repository was to get familiar with the various features of Github and to concisely integrate them. This repository was created as a homework assignment (HW-2b) for our Software Engineering (CSC-510) course under Prof. Timothy Menzies.

We have included a simple src/validate.py file which consists of a class Calculator consisting of methods performing certain list-based manipulations. We have integrated this src directory with our setup.py. This file not only eases installation but provides functionality to integrate testing using Pytest. As can be observed in main.yml, our argument passed to the Github Actions workflow is python setup.py develop && pytest which runs the tests in ./tests/ directory.

Apart from this, we have ensured that the following practices are included while creating this repository - 1. Adding a Kanban style project board 2. Creating Github Issues for proposals/bugs 3. Creating branches/forks and submitting Pull Requests (PRs) 4. These PRs are being reviewed before getting commited 5. Adding descriptive badges 6. Providing an appropriate LICENSE, CODE_OF_CONDUCT, and CONTRIBUTING file with CITATION.cff

Authors

  • Saurabh Nanda (snanda2@ncsu.edu)
  • Radhika Toravi (rtoravi@ncsu.edu)
  • Parth Parikh (pmparikh@ncsu.edu)
  • Jessica Vargas (jrvargas@ncsu.edu)
  • Rushikesh Deodhar (rdeodha@ncsu.edu)

Dependencies

  • Python 3 Python-3
  • Pytest: Pytest

Help

If you have specific queries, please use Issues. If you would like to contribute, we suggest the following steps: 1. Fork the repository (https://github.com/SN-18/SE-Homework-2b/) 2. Create your feature branch (git checkout -b feature/fooBar) 3. Commit your changes (git commit -am 'Add some fooBar') 4. Push to the branch (git push origin feature/fooBar) 5. Create a new Pull Request

For more details, please read our Contributing.md.

Workflow Status

Workflow-Status

Version History

  • v1.0.0
    • Initial Release
  • v1.1.0
    • New features: Includes executable src code, updated LICENSE info, updated COC and README.md to reflect progress made in project

License

License: MIT

Citation Data

DOI

Owner

  • Name: Saurabh Nanda
  • Login: SN-18
  • Kind: user

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Nanda"
  given-names: "Saurabh"
- family-names: "Toravi"
  given-names: "Radhika"
- family-names: "Vargas"
  given-names: "Jessica"
- family-names: "Parikh"
  given-names: "Parth"
- family-names: "Deodhar"
  given-names: "Rushikesh"

title: "Software Engineering(CSC510): HW-2b"
version: v1.1.0
doi: 10.5281/zenodo.5348588
date-released: 2021-9-1
url: "https://doi.org/10.5281/zenodo.5348588"

GitHub Events

Total
Last Year

Dependencies

requirements.txt pypi
  • pytest ==6.2.5