octokit/octokit.net

full scan as JSON

• Consistent naming patternsFollow consistent naming conventions throughout the codebase to improve readability and maintainability: 1. **Client property names shoul...

  octokit/octokit.net Naming Conventions C# devtools 2018-08-10

  copy raw open
• Document public API elementsEvery public API element (classes, methods, properties, constructors) must have XML documentation comments that clearly describe its purp...

  octokit/octokit.net Documentation C# devtools 2023-07-24

  copy raw open
• Use specific assertionsAlways write assertions that verify specific, expected values rather than simple existence or boolean checks. This ensures tests validate...

  octokit/octokit.net Testing C# devtools 2018-06-20

  copy raw open
• Maintain consistent styleFollow established patterns consistently throughout the codebase to improve readability and maintainability: 1. **Use auto properties wit...

  octokit/octokit.net Code Style C# devtools 2022-04-20

  copy raw open
• Use nullable for optionalsWhen a property or parameter represents an optional value that might be absent in requests or responses, use nullable types rather than n...

  octokit/octokit.net Null Handling C# devtools 2018-11-07

  copy raw open
• Design intuitive API methodsWhen designing API methods, prioritize intuitive usage patterns and backwards compatibility. Follow these guidelines: 1. Order parameters...

  octokit/octokit.net API C# devtools 2020-04-14

  copy raw open
• Catch specific exceptionsAlways catch specific exception types rather than using general catch blocks. This improves error handling precision, enables targeted re...

  octokit/octokit.net Error Handling C# devtools 2022-07-06

  copy raw open
• Use async/await patternWhen designing or documenting API clients, always use the async/await pattern rather than blocking calls. Replace code that uses `.GetAwa...

  octokit/octokit.net API Markdown devtools 2019-02-20

  copy raw open
• Abstract configuration accessUse abstraction layers to access configuration settings rather than accessing environment variables, feature flags, or other configuratio...

  octokit/octokit.net Configurations C# devtools 2016-12-23

  copy raw open
• File-specific indentation standardsMaintain consistent indentation based on file type to ensure code readability and prevent unwanted whitespace changes in PRs. Use 4 space...

  octokit/octokit.net Code Style Json devtools 2024-06-29

  copy raw open
• Verify documentation linksAlways ensure external links in documentation are valid, secure, and point to authoritative sources. This includes: 1. Use HTTPS instead ...

  octokit/octokit.net Documentation Markdown devtools 2023-02-06

  copy raw open
• Secure permission modelingWhen implementing security-related models such as permissions, carefully design the properties to prevent unauthorized modifications and ...

  octokit/octokit.net Security C# devtools 2023-01-06

  copy raw open
• Use appropriate framework targetsWhen configuring .NET projects, always use the correct target framework elements and versions: 1. Use the singular `` el...

  octokit/octokit.net Configurations Other devtools 2022-08-10

  copy raw open
• Precise and consistent namingNames should clearly indicate their specific purpose and context, while\ \ maintaining correct capitalization of brand names and products...

  octokit/octokit.net Naming Conventions Other devtools 2015-10-16

  copy raw open