Feedback

proposal.md

@@ -1,36 +1,35 @@
 # Community Software Analysis Proposal
 Please edit this file and push to your repository.
 
-## Software: *NAME_OF_PACKAGE_HERE*
+## Software: OpenFOAM
 
-*Write a paragraph describing what the software does and who its
-primary audience is.*
+OpenFOAM is an open source Computational Fluid Dynamics (CFD) code used in academia and industry for problems ranging from solid mechanics to fluid flows of varying complexity. It was created on 2004 and is managed by OpenCFD with the mission of providing a highly functional, freely available, and open source CFD software.
 
 ### Stats
 
 | Description | Your answer |
 |---------|-----------|
-| Repository URL |    |
-| Main/documentation website |    |
-| Year project was started |   |
-| Number of contributors in the past year | `git shortlog -se --since=2021-10-01` may be useful |
-| Number of contributors in the lifetime of the project |   |
-| Number of distinct affiliations | 1, 2-5, 5-10, >10 |
-| Where do development discussions take place? | e.g., GitHub/GitLab issues, mailing list, Slack, etc.  |
-| Typical number of emails/comments per week? |   |
-| Typical number of commits per week? |  |
-| Typical commit size | `git log --shortstat` may be useful |
-| How does the project accept contributions? | e.g., pull requests, patches on mailing lists   |
-| Does the project have an automated test suite? | yes/no |
-| Does the project use continuous integration? | yes/no |
-| Are any legal/licensing steps required to contribute? | no or explain below |
+| Repository URL |  https://github.com/OpenFOAM/OpenFOAM-dev  |
+| Main/documentation website |  https://openfoam.org/resources/  |
+| Year project was started |  Dec 2004 |
+| Number of contributors in the past year | `git shortlog -se --since=2021-10-01` -> 4 |
+| Number of contributors in the lifetime of the project | 11 |
+| Number of distinct affiliations | 5-10 "Organizations Signing the contributor agreement" |
+| Where do development discussions take place? | Mailing list, issue tracking system  |
+| Typical number of emails/comments per week? |  9 issue updates on the above link per week |
+| Typical number of commits per week? | ~25 |
+| Typical commit size | `git log --shortstat` shows anywhere from 1 to 180 insertions/deletions per commit |
+| How does the project accept contributions? | pull requests  |
+| Does the project have an automated test suite? | Yes - "tutorials" that walk through examples |
+| Does the project use continuous integration? | Yes - they have a dev version officially released annually that is continually updated |
+| Are any legal/licensing steps required to contribute? | Yes -> explained below |
 
 ### Install and run
 
 Check the following boxes when complete or add a note below if you
 encountered a problem.
 
-- [ ] I have installed the software
+- [x] I have installed the software
 - [ ] I have run at least one example
 - [ ] I have run the test suite
 - [ ] The test suite passes
@@ -44,6 +43,15 @@ the project requires a contributor license agreement or other
 procedural steps, please explain here.  "None at this time" is
 acceptable for this question.
 
+Legal: Once a contribution is made, the contributor has to sign the OpenFOAM Foundation Contributor Agreement, which essentially transfers ownership of the code to OpenFOAM so they can take legal action against those who infringe the OpenFOAM licence (GNU General Public License).
+
+Note: I was unable to find a place where development discussions are had. I simply found the issue tracking system. This may make sense with how few contributers there are, as I could imagine they communicate directly.
+
+Note1: Tracking system link: (https://bugs.openfoam.org/view_all_bug_page.php) 
+
+Note2: I have the repo cloned, but my lack of experience is making it hard to complete the rest of this. will try again tomorrow.
+Note2 update: unable to get the test case working
+
 #### Note on copyright
 Students retain copyright on any work done in completion of a CU
 course, so you are authorized to sign a [contributor license