Merge branch 'master' of https://github.com/capnramses/pro_programming_tools_c_cpp

Author: capnramses

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

CONTRIBUTING.md

@@ -0,0 +1,14 @@
+# Contribution Guidelines
+
+Please feel encouraged to make a pull request (PR) to correct or clarify code.
+
+Some rough guidelines for making a PR:
+
+* Bug fixes and operating-system specific fixes are very welcome.
+* When making a PR please make sure both the PR and the code is commented clearly for other book readers.
+* Do not introduce code copy-pasted from elsewhere as there are licencing and copyright issues with this.
+* Please do not submit CMakeLists.txt or build scripts for the entire book or for individual chapters. There is a specific chapter dedicated to introducing build systems.
+* Please do not submit project or solution files for a particular IDE.
+* Code in examples is copy-pasted from the book. If the PR needs to modify these please add a comment to those lines indicating why the change was important.
+* Code style and language version changes are discouraged unless they fix a bug.
+* If you are happy to be added to a contributors list then please add your name, as you would like it to appear, as a bullet at the bottom of this file.

README.md

@@ -64,7 +64,7 @@ Please feel free to use the [Issues](https://github.com/capnramses/pro_programmi
 
 ## Contributions and Pull Requests
 
-Please feel encouraged to make a pull request to correct or clarify code.
+Please feel encouraged to make a pull request (PR) to correct or clarify code.
 
 Some rough guidelines for making a PR:
 
@@ -75,4 +75,8 @@ Some rough guidelines for making a PR:
 * Please do not submit project or solution files for a particular IDE.
 * Code in examples is copy-pasted from the book. If the PR needs to modify these please add a comment to those lines indicating why the change was important.
 * Code style and language version changes are discouraged unless they fix a bug.
-* In your PR please indicate if you are happy to be added to a contributors list, and if so the name and/or handle you would like to be credited as.
+* If you are happy to be added to a contributors list then please add your name, as you would like it to appear, as a bullet at the bottom of this file.
+
+## Contributors
+
+* [Anton Gerdelan](https://github.com/capnramses) - Initial code.

ch03_02_read_entire_file/main.c

@@ -9,32 +9,32 @@ Repository: https://github.com/capnramses/pro_programming_tools_c_cpp
 #include <string.h>
 
 struct file_record_t {
-	void* data;
+  void* data;
   size_t sz;
 };
-    
+
 struct file_record_t read_file( const char* filename ) {
-	struct file_record_t record;
+  struct file_record_t record;
   memset( &record, 0, sizeof( struct file_record_t ) );
-        
+
   FILE* fp = fopen( filename, "rb" );
-	if ( !fp ) { return record; }
+  if ( !fp ) { return record; }
   fseek( fp, 0L, SEEK_END );
   record.sz   = (size_t)ftell( fp );
   record.data = malloc( record.sz );
   rewind( fp );
   fread( record.data, record.sz, 1, fp );
   fclose( fp );
-  
+
   return record;
 }
 
 int main() {
-	struct file_record_t record = read_file( "in.ppm" );
-	if ( !record.data ) {
-		fprintf( stderr, "ERROR: reading file `in.ppm`\n" );
-		return 1;
-	}
-	printf( "put entire file `in.ppm` in memory. %u bytes. data %p\n", (unsigned int)record.sz, (void*)record.data );
-	return 0;
+  struct file_record_t record = read_file( "in.ppm" );
+  if ( !record.data ) {
+    fprintf( stderr, "ERROR: reading file `in.ppm`\n" );
+    return 1;
+  }
+  printf( "put entire file `in.ppm` in memory. %u bytes. data %p\n", (unsigned int)record.sz, (void*)record.data );
+  return 0;
 }