merge to development (#158)

nam20485 · Jan 15, 2024 · 9da8b7f · 9da8b7f
2 parents ebf679f + 1a4a2e5
commit 9da8b7f
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 6 deletions.
diff --git a/OdbDesignLib/FileModel/Design/AttrListFile.cpp b/OdbDesignLib/FileModel/Design/AttrListFile.cpp
@@ -44,7 +44,7 @@ namespace Odb::Lib::FileModel::Design
 			loginfo("checking for extraction...");
 
 			std::filesystem::path featuresFilePath;
-			for (const std::string& featuresFilename : ATTRLIST_FILENAMES)
+			for (const std::string featuresFilename : ATTRLIST_FILENAMES)
 			{
 				loginfo("trying attrlist file: [" + featuresFilename + "]...");
 

diff --git a/OdbDesignLib/FileModel/Design/ComponentsFile.cpp b/OdbDesignLib/FileModel/Design/ComponentsFile.cpp
@@ -311,7 +311,7 @@ namespace Odb::Lib::FileModel::Design
 			loginfo("checking for extraction...");
 
 			std::filesystem::path componentsFilePath;
-			for (const std::string& componentsFilename : COMPONENTS_FILENAMES)
+			for (const std::string componentsFilename : COMPONENTS_FILENAMES)
 			{
 				loginfo("trying components file: [" + componentsFilename + "]...");
 

diff --git a/OdbDesignLib/FileModel/Design/FeaturesFile.cpp b/OdbDesignLib/FileModel/Design/FeaturesFile.cpp
@@ -53,7 +53,7 @@ namespace Odb::Lib::FileModel::Design
 			}
 
 			std::filesystem::path featuresFilePath;
-			for (const std::string& featuresFilename : filenames)
+			for (const std::string featuresFilename : filenames)
 			{
 				loginfo("trying features file: [" + featuresFilename + "]...");
 

diff --git a/docs/README.md b/docs/README.md
@@ -31,6 +31,8 @@ The maintainer has well over a decade of experience in the PCB Manufacturing and
 
 All code, dependency packages, and Docker images are scanned for security vulnerabilities, using extended security scanning rule profiles (these are more secure than the default base scanning rule profiles).
 
+>The project has earned a high score on the [OpenSSF Security Scorecard](https://securityscorecards.dev/#what-is-openssf-scorecard). Details can be seen in the [Project Security](#project-security) section below.
+
 It is built using the latest available version of the C++ standard and is compiled with the latest available compiler versions. The parser is also built using the latest available versions of all of its dependencies and is regularly updated to use the latest versions of those dependencies as they are released.
 
 >These checks are run against all branches starting with development, so there is no chance of a security vulnerability being introduced into the main and release branches. Docker's Scout Suite is used to scan the Docker image for security vulnerabilities, and GitHub's CodeQL is used to scan the code for security vulnerabilities.
@@ -39,19 +41,21 @@ It is built using the latest available version of the C++ standard and is compil
 
 ### Current Implementation State
 
-The diagram describes the current state of parser implementation and data availability. Green color describes areas of the ODB++ archive file that are implemented and have their data available for use. Red color describes areas that are not parsed so their data is not yet available.
+The diagram describes the current state of parser implementation and data availability. Green color describes areas of the ODB++ archive file that are implemented and have their data available for use. ~~Red color describes areas that are not parsed so their data is not yet available.~~ **All areas of the file are now parsed, and have their data available for use.**
 
 ![ODB++ file hierarchy implementation state diagram](<odb++ file hierarchy (implemented).png>)
 
-### CI/CD Build
+### Project Security
 
 #### OpenSSF Security Scorecard
 
 [OpenSSF Security Scorecard](https://securityscorecards.dev/#what-is-openssf-scorecard) assesses open source projects for security risks through a series of automated checks.
 
 [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/nam20485/OdbDesign/badge)](https://securityscorecards.dev/viewer/?uri=github.com/nam20485/OdbDesign)
 
->90% of tested projects have a score of less than 4.0/10, so OdbDesign's 7.2 score represents a remarkably high level of security.
+>The majority of tested projects have a muc lower score, so OdbDesign's 7.8 score represents a remarkably high level of security.
+
+### CI/CD Build
 
 #### Branches
 
@@ -186,6 +190,12 @@ Data objects returned from the parser library support serialization to and from
 
 >The protocol buffer definitions are included in the library so they can be used to generate code for other languages - currently C++ bindings are built and used in the library.
 
+## Contributing
+
+The project is happy to accept pull requests if you would like to contribute. Please open an issue to discuss your proposed changes before submitting a pull request. Pull requests are accepted against the `development` branch. Please make sure your pull request is up to date with the latest changes in the `development` branch before submitting it.
+
+All contributed code must be covered by accompanying test cases. Please make sure your changes are covered by test cases before submitting a pull request.
+
 ## License
 
 This project is free and open source under the MIT [license](https://github.com/nam20485/OdbDesign/blob/c0c8b6e4b93e1c7d4d5e65c7ad25157c883f8bfb/LICENSE).