📝 Update documentation

Author: stoe

.github/contributing.md

@@ -1,8 +1,8 @@
 # Contributing to action-reporting-cli
 
-Thank you for your interest in contributing to this project! We welcome contributions from the community and are pleased that you're interested in helping improve action-reporting-cli.
+Thanks for your interest in contributing to this project! We welcome contributions from the community and we're glad you're interested in helping improve action-reporting-cli.
 
-This document outlines the process for contributing to this project and provides guidelines to make the contribution process smooth and effective.
+This document outlines the process for contributing to the project and provides guidelines to make the contribution process smooth and effective.
 
 ## Code of Conduct
 
@@ -19,6 +19,7 @@ Before creating bug reports, please check the existing issues to avoid duplicate
 - Expected behavior versus actual behavior
 - Screenshots or terminal output (if applicable)
 - Environment details (OS, Node.js version, etc.)
+- Command line arguments you used with the tool
 
 ### Suggesting Enhancements
 
@@ -41,6 +42,8 @@ Follow these steps to submit your contributions:
 6. Push to your branch (`git push origin my-new-feature`)
 7. Create a new Pull Request
 
+When submitting pull requests that affect functionality, please make sure to update the relevant documentation in the README.md file as well.
+
 ## Development Guidelines
 
 ### Getting Started
@@ -66,19 +69,24 @@ Follow these steps to submit your contributions:
 ### Project Structure
 
 - `src/`: Main source code
-  - `github/`: GitHub API interaction classes
-  - `report/`: Report generation modules
-  - `util/`: Utility functions for logging, caching, etc.
-- `test/`: Unit tests
-- `cli.js`: Main entry point
+  - `github/`: GitHub API interaction classes (Enterprise, Owner, Repository, Workflow)
+  - `report/`: Report generation modules (CSV, JSON, Markdown)
+  - `util/`: Utility functions for logging, caching, and rate limiting
+- `test/`: Unit tests with corresponding structure to src/
+  - `__fixtures__/`: Test data for unit tests
+  - `__mocks__/`: Mock implementations for testing
+- `cli.js`: Main entry point for the command-line tool
 
 ### Coding Standards
 
 - Follow the existing code style (we use prettier and ESLint)
 - Write documentation for new methods, classes, and functions
 - Include JSDoc comments for public APIs
-- Keep functions focused and modular
-- Write tests for new functionality
+- Keep functions focused and modular (generally under 50 lines)
+- Use clear, descriptive variable and function names
+- Handle errors consistently throughout the codebase
+- Keep all lines, including comments, under 120 characters
+- Write tests for all new functionality
 
 ### Commit Message Guidelines
 
@@ -109,12 +117,15 @@ Examples:
 - All new features should include corresponding tests
 - Run the test suite before submitting a pull request: `npm test`
 - Ensure your changes don't break existing functionality
+- If you're fixing a bug, consider adding a test that would have caught the bug
 
 ## Documentation
 
 - Update the README.md with any necessary changes
 - Document new features, options, or behavior changes
 - Consider updating examples if relevant
+- Use a conversational tone that matches the existing documentation
+- For command examples, use the format shown in the README (e.g., `my-org/my-repo` for repository names)
 
 ## Review Process
 
@@ -125,5 +136,6 @@ Examples:
 ## Additional Resources
 
 - [GitHub Pull Request Documentation](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests)
+- [Test documentation](../test/readme.md) for detailed testing information
 
-Thank you for contributing to action-reporting-cli!
+Thanks for contributing to action-reporting-cli!