agentleFS
Sign inStart free
Microsoft AzureKnown publisherAzure/osdu-spi/.github/fork-resources/copilot-instructions.md

osdu-spi / fork-resources

Copilot instructions1 starsChanged 32 days agoApache-2.0View on GitHub

This is a forked repository of the OSDU project, optimized for GitHub Copilot use. The following guidelines are designed to enhance clarity and efficiency in development practices, ensuring a smooth workflow for contributors. Three parties own different parts of this tree. .github/CODEOWNERS maps the paths; check it before editing. Commits must follow the Conventional Commits standard: Valid Types: Descriptive naming aligned to issue tracking: Local Test Commands:

  • Commits and pushes

13 other projects use a version of this.

Adopted by

Most recently taken up by

  • Other versions13 projects use a version of this.

    Word for word · 13

    1. Azure/osdu-spi-crs-catalog★ 0100% same
    2. Azure/osdu-spi-crs-conversion★ 0100% same
    3. Azure/osdu-spi-entitlements★ 0100% same
    4. Azure/osdu-spi-file★ 0100% same
    5. Azure/osdu-spi-indexer★ 0100% same
    6. Azure/osdu-spi-indexer-queue★ 0100% same
    7. Azure/osdu-spi-legal★ 0100% same
    8. Azure/osdu-spi-partition★ 0100% same
    9. Azure/osdu-spi-schema★ 0100% same
    10. Azure/osdu-spi-search★ 0100% same

    3 more not listed

    Edited · 0

    None found.

    Wrote their own version · 0

    None found.

    How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.

  • Where files are headingNew Copilot instructions files have more rules about branches and pull requests, and fewer about code style.

    Of the Copilot instructions files we read, the 2,336 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.

  • In this repository2 other files it gives its agents.

The file

We split this copilot-instructions.md into the rules it gives an agent

5 rules. About 0 are common, 3 are distinctive, and 2 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈3

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 2

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Use imperative mood ("fix bug", not "fixed")

    line 54
  2. Distinctive:

    No emojis or special characters

    line 55
  3. Very specific:

    No brackets or prefixes (e.g., [feat])

    line 57
  4. Very specific:

    Create PRs using gh pr create

    line 81
  5. Distinctive:

    Ensure all CI checks pass

    line 84

≈ “Common” is an estimate: at least 1 in 5 of the 3,779 Copilot instructions files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
copilot-instructions.md

This is a forked repository of the OSDU project, optimized for GitHub Copilot use. The following guidelines are designed to enhance clarity and efficiency in development practices, ensuring a smooth workflow for contributors.

Repository Structure

  • Important Branches:

    • main: Protected production (semantic releases)
    • fork_upstream: Auto-sync from upstream
    • fork_integration: Conflict resolution staging

Ownership

Three parties own different parts of this tree. .github/CODEOWNERS maps the paths; check it before editing.

AreaOwnerWhat to do with a change
Shared service code (everything not listed below)Upstream OSDUDo not edit here. Contribute the change upstream, or port a specific upstream fix and add the port label to the PR (ADR-038). The next sync will conflict with anything else.
provider/*-azure/, testing/*-test-azure/, .spi/, .github/upstream-filter.yml, .github/CODEOWNERS, CONTRIBUTING.md, README.mdThis forkNormal feature work.
.github/ (except the two fork-owned files above), build/, .release-please-config.jsonThe template (Azure/osdu-spi)Do not edit here. Template sync overwrites these files; change the template instead.

Commit Standards

Conventional Commit Format

Commits must follow the Conventional Commits standard:

<type>(<scope>): <description>

[optional body]

[optional footer(s)]

Valid Types:

  • feat: New feature
  • fix: Bug fix
  • feat!: Breaking feature change
  • fix!: Breaking bug fix
  • chore: Maintenance (no version bump)
  • docs: Documentation
  • ci: CI/CD configuration
  • refactor: Code refactoring
  • test: Tests

Rules

  • Use imperative mood ("fix bug", not "fixed")
  • No emojis or special characters
  • Lowercase type, colon, and space required (fix: correct bug)
  • No brackets or prefixes (e.g., [feat])

Example:

feat: add login middleware

Branch Naming

Descriptive naming aligned to issue tracking:

feat/issue-123-add-auth
fix/issue-456-memory-leak
chore/update-dependencies

Pull Request Workflow

  • Create PRs using gh pr create
  • PR title in conventional commit format
  • Reference issues clearly (e.g., Fixes #123)
  • Ensure all CI checks pass

Automation Workflows

WorkflowPurpose
sync.ymlSync from upstream; auto-create PRs
build.ymlBuild/test Java Maven projects
validate.ymlCommit message validation and conflict check
release.ymlAutomate semantic version releases
sync-template.ymlUpdate from fork templates
cascade.ymlPropagate updates to downstream forks
cascade-monitor.ymlMonitor update propagation

Testing Standards

  • Behavior-driven development (BDD)
  • Maintain 80%+ test coverage

Local Test Commands:

mvn clean install
mvn test
mvn versions:display-dependency-updates

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free