Skip to content

Commit

Permalink
Update proj3rubric.md (#134)
Browse files Browse the repository at this point in the history
* Update proj3rubric.md

* Added wiki images

* Update proj3rubric.md

* Added youtube link to readme

Co-authored-by: peeyush10234 <10905673+peeyush10234@users.noreply.github.com>
Co-authored-by: peeyush10234 <tanejapeeyush@gmail.com>
Co-authored-by: Leila Moran <lmmoran@ncsu.edu>
  • Loading branch information
3 people authored Dec 5, 2021
1 parent bb24d3f commit 4464b44
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 14 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,16 @@

---

Project 3 demo video:

Watch it on youtube! https://www.youtube.com/watch?v=KBBqUkOTuSo

Watch it here:

https://user-images.githubusercontent.com/89357283/144730581-46b85493-3f5c-4c65-9d3f-fbcfffc729a3.mp4



---


Expand Down
Binary file added data/proj3media/apps.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added data/proj3media/hooks.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added data/proj3media/integrations.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
28 changes: 14 additions & 14 deletions docs/proj3rubric.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
|Score|Notes| Evidence|
|-|-----|---------|
|.5| short release cycles| https://github.com/CSC510-Group-25/ClassMateBot/releases |
|.5| workload is spread over the whole team (so one team member is often Xtimes more productive than the others...| https://github.com/CSC510-Group-25/ClassMateBot/pulse |
|.5|Docs: why: docs tell a story, motivate the whole thing, deliver a punchline that makes you want to rush out and use the thing | https://github.com/CSC510-Group-25/ClassMateBot/blob/main/README.md|
|.5|the files CONTRIBUTING.md lists coding standards and lots of tips on how to extend the system without screwing things up | https://github.com/CSC510-Group-25/ClassMateBot/blob/main/CONTRIBUTING.md
|.5| workload is spread over the whole team (so one team member is often Xtimes more productive than the others...| [pulse](https://github.com/CSC510-Group-25/ClassMateBot/pulse) |
|.5|Docs: why: docs tell a story, motivate the whole thing, deliver a punchline that makes you want to rush out and use the thing | [README video](https://github.com/CSC510-Group-25/ClassMateBot/blob/main/README.md)|
|.5|the files CONTRIBUTING.md lists coding standards and lots of tips on how to extend the system without screwing things up | [Contributing](https://github.com/CSC510-Group-25/ClassMateBot/blob/main/CONTRIBUTING.md) |
|.5|Docs: doco generated , format not ugly | in GH |
|.5|evidence that the whole team is using the same tools (e.g. config files in the repo, updated by lots of different people) | [.pylintrc](https://github.com/CSC510-Group-25/ClassMateBot/blob/main/.pylintrc), [requirements.txt](https://github.com/CSC510-Group-25/ClassMateBot/blob/main/requirements.txt), [Wiki Installation Guide](https://github.com/CSC510-Group-25/ClassMateBot/wiki/Setup-&-Installation-guide), [Tooks, Hooks, Services](https://github.com/CSC510-Group-25/ClassMateBot/wiki/Tools,-Hooks,-and-Services) |
|.5|evidence that the members of the team are working across multiple places in the code base | https://github.com/CSC510-Group-25/ClassMateBot/branches/active, https://github.com/CSC510-Group-25/ClassMateBot/commits/main|
|1|Docs: what: point descriptions of each class/function (in isolation) | [Command documents](https://github.com/CSC510-Group-25/ClassMateBot/tree/group25-documentation/docs) |
|.5|evidence that the whole team is using the same tools (e.g. config files in the repo, updated by lots of different people) | [.pylintrc](https://github.com/CSC510-Group-25/ClassMateBot/blob/main/.pylintrc), [requirements.txt](https://github.com/CSC510-Group-25/ClassMateBot/blob/main/requirements.txt), [Wiki Installation Guide](https://github.com/CSC510-Group-25/ClassMateBot/wiki/Setup-&-Installation-guide), [Tooks/Hooks/Services](https://github.com/CSC510-Group-25/ClassMateBot/wiki/Tools,-Hooks,-and-Services) |
|.5|evidence that the members of the team are working across multiple places in the code base | [here](https://github.com/CSC510-Group-25/ClassMateBot/branches/active) and [here](https://github.com/CSC510-Group-25/ClassMateBot/commits/main)|
|1|Docs: what: point descriptions of each class/function (in isolation) | [Command documents](https://github.com/CSC510-Group-25/ClassMateBot/tree/main/docs) |
|.5|Number of commits: by different people | in GH|
|1|issues are being closed | evidence in GH|
|.5|issues are discussed before they are closed | Issues are closed with approved pull requests and discussed over Discord. Examples - https://github.com/CSC510-Group-25/ClassMateBot/issues/122 and https://github.com/CSC510-Group-25/ClassMateBot/issues/103 |
|.5|Use of syntax checkers. | [Pylint](https://github.com/CSC510-Group-25/ClassMateBot/blob/main/.github/workflows/pylint.yml), Codacy |
|.5|issues are discussed before they are closed | Issues are closed with approved pull requests and discussed over Discord. Examples: [here](https://github.com/CSC510-Group-25/ClassMateBot/issues/122) and [here](https://github.com/CSC510-Group-25/ClassMateBot/issues/103) |
|.5|Use of syntax checkers. | [Pylint](https://github.com/CSC510-Group-25/ClassMateBot/blob/main/.github/workflows/pylint.yml), [Codacy](https://app.codacy.com/gh/CSC510-Group-25/ClassMateBot/dashboard) |
|1|Issues reports: there are many | [Issues](https://github.com/CSC510-Group-25/ClassMateBot/issues) |
|.5|Use of code formatters. | Black, [requirements.txt](https://github.com/CSC510-Group-25/ClassMateBot/blob/main/requirements.txt) |
|.5|Use of style checkers | [Pylint](https://github.com/CSC510-Group-25/ClassMateBot/blob/main/.github/workflows/pylint.yml), Codacy |
|.5|Docs: short video, animated, hosted on your repo. That convinces people why they want to work on your code. | |
|.5|Use of style checkers | [Pylint](https://github.com/CSC510-Group-25/ClassMateBot/blob/main/.github/workflows/pylint.yml), [Codacy](https://app.codacy.com/gh/CSC510-Group-25/ClassMateBot/dashboard) |
|.5|Docs: short video, animated, hosted on your repo. That convinces people why they want to work on your code. | [youtube](https://www.youtube.com/watch?v=KBBqUkOTuSo) or the first video on the [README](https://github.com/CSC510-Group-25/ClassMateBot/blob/main/README.md)|
|.5|test cases exist | https://github.com/CSC510-Group-25/ClassMateBot/blob/main/test/test_bot.py |
|.5|Use of code coverage | [Codecov](https://github.com/CSC510-Group-25/ClassMateBot/blob/main/.github/workflows/main.yml) |
|.5|other automated analysis tools | [Pylint](https://github.com/CSC510-Group-25/ClassMateBot/blob/main/.github/workflows/pylint.yml), Codacy, Snyk |
|.5|test cases:a large proportion of the issues related to handling failing cases. | https://github.com/CSC510-Group-25/ClassMateBot/issues?q=label%3Atest+ and https://github.com/CSC510-Group-25/ClassMateBot/issues?q=label%3Abug+is%3Aclosed |
|.5|Use of code coverage | [Codecov](https://github.com/CSC510-Group-25/ClassMateBot/actions/workflows/codeql-analysis.yml) |
|.5|other automated analysis tools | [Snyk](https://github.com/CSC510-Group-25/ClassMateBot/pull/120), Dependabot |
|.5|test cases:a large proportion of the issues related to handling failing cases. | [here](https://github.com/CSC510-Group-25/ClassMateBot/issues?q=label%3Atest+) and [here](https://github.com/CSC510-Group-25/ClassMateBot/issues?q=label%3Abug+is%3Aclosed) |
|.5|test cases are routinely executed | [Pytest workflow](https://github.com/CSC510-Group-25/ClassMateBot/actions/workflows/pytest.yml) |
|1|Documentation describing how this version improves on the older version| [Proj3Changes](https://github.com/CSC510-Group-25/ClassMateBot/blob/group25-documentation/docs/Project3Changes.md) |
|1|Documentation describing how this version improves on the older version| [Proj3Changes](https://github.com/CSC510-Group-25/ClassMateBot/blob/main/docs/Project3Changes.md) |
|3|This version is a little(1), some(2), much(3) improved on the last version.|Tutor's assessment.|
|16| Total|

0 comments on commit 4464b44

Please sign in to comment.