Cleanup docs and templates

.github/CONTRIBUTING.md

@@ -9,28 +9,27 @@ We don't use GitHub as a support forum. For any usage questions that are not spe
 ## Reporting Issues
 
 A great way to contribute to the project is to send a detailed issue when you encounter an problem.
-It is very important to check for the same problem or suggestion in the project's issue list first. If you find a match, just add a small comment there. 
+It is very important to check for the same problem or suggestion in the project's issue list first. If you find a match, just add a small comment there. If the issue is closed and you think it is still occuring in the latest version, please re-open the issue.
 Doing this helps prioritize the most common problems and requests.
 
 When reporting issues, please include the following:
 
-- The platform name and version (e.g. iOS 8.1)
+- The platform name and version (e.g. iOS 13.4)
 - The library version
-- The integration method (e.g. CocoaPods/Carthage/manually)
+- The integration method (e.g. Swift Package Manager / CocoaPods / Carthage / manually)
 - The version of Xcode you're using
 - The full output of any stack trace or compiler error
-- A small demo project that replicates the issue (especially if the way to reproduce the issue is not straight-forward)
+- A small reproduction project that replicates the issue (especially if the way to reproduce the issue is not straight-forward)
 - Any other details that would be useful in understanding the problem
 
 This information will help us review and fix your issue faster.
 
-
 Please do not be offended if we close your issue and reference this document. 
 If you believe the issue is truely a fault in the project’s codebase, re-open it.
 
 ## Pull Requests
 
-We gladly accept any PR's assuming they are well written, documented ( if necessary ) and preferably have test code. 
+We gladly accept any PR's assuming they are well written, documented (if necessary) and preferably have test code. 
 If you're unsure if we'll accept a new feature please open an issue requesting it and we can have a discussion before you code and submit a PR.
 
 Checklist:
@@ -38,5 +37,4 @@ Checklist:
 - If you've added code that should be tested, add tests.
 - If you've changed APIs, update the documentation.
 - Ensure the test suite passes.
-- Make sure your code lints (pod lib lint)
-
+- Make sure your code lints (`pod lib lint`)

.github/ISSUE_TEMPLATE.md

@@ -1,20 +1,20 @@
 ### New Issue Checklist
 
-* [ ] I have read and understood the [CONTRIBUTING guide](https://github.com/CocoaLumberjack/CocoaLumberjack/blob/master/.github/CONTRIBUTING.md)
-* [ ] I have read the [Documentation](https://github.com/CocoaLumberjack/CocoaLumberjack#documentation) or [CocoaDocs](cocoadocs.org/docsets/CocoaLumberjack)
-* [ ] I have searched for a similar issue in the [project](https://github.com/CocoaLumberjack/CocoaLumberjack/issues) and found none
+- [ ] I have read and understood the [CONTRIBUTING guide](https://github.com/CocoaLumberjack/CocoaLumberjack/blob/master/.github/CONTRIBUTING.md)
+- [ ] I have read the [Documentation](https://github.com/CocoaLumberjack/CocoaLumberjack#documentation) or [CocoaDocs](cocoadocs.org/docsets/CocoaLumberjack)
+- [ ] I have searched for a similar issue in the [project](https://github.com/CocoaLumberjack/CocoaLumberjack/issues) and found none
 
 ### Issue Info
 
  Info                    | Value                               |
 -------------------------|-------------------------------------|
- Platform Name           | e.g. ios / osx / tvos / watchos
- Platform Version        | e.g. 8.0
- CocoaLumberjack Version | e.g. 2.3.0
- Integration Method      | e.g. carthage / cocoapods / manually
- Xcode Version           | e.g. Xcode 7.3
+ Platform Name           | e.g. ios / macos / tvos / watchos
+ Platform Version        | e.g. 13.0
+ CocoaLumberjack Version | e.g. 3.7.4
+ Integration Method      | e.g. spm / carthage / cocoapods / manually
+ Xcode Version           | e.g. Xcode 13.4
  Repro rate              | e.g. all the time (100%) / sometimes x% / only once
- Demo project link       | e.g. link to a demo project that highlights the issue
+ Repro project link      | e.g. link to a reproduction project that highlights the issue
 
 ### Issue Description and Steps
 

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,18 +1,19 @@
 ### New Pull Request Checklist
 
-* [ ] I have read and understood the [CONTRIBUTING guide](https://github.com/CocoaLumberjack/CocoaLumberjack/blob/master/.github/CONTRIBUTING.md)
-* [ ] I have read the [Documentation](http://cocoadocs.org/docsets/CocoaLumberjack/)
-* [ ] I have searched for a similar pull request in the [project](https://github.com/CocoaLumberjack/CocoaLumberjack/pulls) and found none
+- [ ] I have read and understood the [CONTRIBUTING guide](https://github.com/CocoaLumberjack/CocoaLumberjack/blob/master/.github/CONTRIBUTING.md)
+- [ ] I have read the [Documentation](http://cocoadocs.org/docsets/CocoaLumberjack/)
+- [ ] I have searched for a similar pull request in the [project](https://github.com/CocoaLumberjack/CocoaLumberjack/pulls) and found none
 
-* [ ] I have updated this branch with the latest master to avoid conflicts (via merge from master or rebase)
-* [ ] I have added the required tests to prove the fix/feature I am adding
-* [ ] I have updated the documentation (if necessary)
-* [ ] I have run the tests and they pass
-* [ ] I have run the lint and it passes (`pod lib lint`)
+<br/>
+
+- [ ] I have updated this branch with the latest master to avoid conflicts (via merge from master or rebase)
+- [ ] I have added the required tests to prove the fix/feature I am adding
+- [ ] I have updated the documentation (if necessary)
+- [ ] I have run the tests and they pass
+- [ ] I have run the lint and it passes (`pod lib lint`)
 
 This merge request fixes / refers to the following issues: ...
 
 ### Pull Request Description
 
 ...
-

Documentation/LogFileManagement.md

@@ -9,12 +9,12 @@ The `DDFileLogger` implementation, as you may now have guessed, is split into tw
 There are two ways to initialize a `DDFileLogger` instance:
 ```objc
 @interface DDFileLogger : NSObject <DDLogger>
-...
+/* ... */
 
-- (instancetype)init;
 - (instancetype)initWithLogFileManager:(id <DDLogFileManager>)logFileManager NS_DESIGNATED_INITIALIZER;
+- (instancetype)init;
 
-...
+/* ... */
 @end
 ```
 
@@ -37,17 +37,17 @@ Let's take a look at the DDLogFileManager protocol:
 
 - (NSString *)logsDirectory;
 
-- (NSArray *)unsortedLogFilePaths;
-- (NSArray *)unsortedLogFileNames;
-- (NSArray *)unsortedLogFileInfos;
+@property (nonatomic, readonly, strong) NSArray<NSString *> *unsortedLogFilePaths;
+@property (nonatomic, readonly, strong) NSArray<NSString *> *unsortedLogFileNames;
+@property (nonatomic, readonly, strong) NSArray<DDLogFileInfo *> *unsortedLogFileInfos;
 
-- (NSArray *)sortedLogFilePaths;
-- (NSArray *)sortedLogFileNames;
-- (NSArray *)sortedLogFileInfos;
+@property (nonatomic, readonly, strong) NSArray<NSString *> *sortedLogFilePaths;
+@property (nonatomic, readonly, strong) NSArray<NSString *> *sortedLogFileNames;
+@property (nonatomic, readonly, strong) NSArray<DDLogFileInfo *> *sortedLogFileInfos;
 
 // Private methods (only to be used by DDFileLogger)
 
-- (NSString *)createNewLogFileWithError(NSError**)error;
+- (nullable NSString *)createNewLogFileWithError(NSError **)error;
 
 @optional