Skip to content

(Agent) Friendly Contrib#3637

Merged
iancooper merged 6 commits into
masterfrom
agent-friendly-contrib
Jul 3, 2025
Merged

(Agent) Friendly Contrib#3637
iancooper merged 6 commits into
masterfrom
agent-friendly-contrib

Conversation

@iancooper

Copy link
Copy Markdown
Member

Our contributing.md file is missing a lot of information about our preferred development style. This makes it hard for new developers to understand our preferences. Much of this is given by word of mouth.

In addition, when asking GitHub Copilot, how could we make your life easier, it opted for a contributing.md file over a custom prompt file. It will read the contributing.md file, if it is in the project, when making suggestions. I then asked it what a better contributing.md file would look like, and it gave me a set of headings and some examples of what it thought we applied.

So, this is about creating a more detailed contributing.md

@codescene-delta-analysis codescene-delta-analysis Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gates Passed
6 Quality Gates Passed

See analysis details in CodeScene

Quality Gate Profile: Clean Code Collective
Want more control? Customize Code Health rules or catch issues early with our IDE extension and CLI tool.

@codescene-delta-analysis codescene-delta-analysis Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gates Passed
6 Quality Gates Passed

See analysis details in CodeScene

Quality Gate Profile: Clean Code Collective
Want more control? Customize Code Health rules or catch issues early with our IDE extension and CLI tool.

@codescene-delta-analysis codescene-delta-analysis Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gates Passed
6 Quality Gates Passed

See analysis details in CodeScene

Quality Gate Profile: Clean Code Collective
Want more control? Customize Code Health rules or catch issues early with our IDE extension and CLI tool.

@iancooper iancooper marked this pull request as ready for review July 3, 2025 08:41
@iancooper iancooper merged commit 3b608ef into master Jul 3, 2025
6 checks passed
@iancooper iancooper deleted the agent-friendly-contrib branch July 3, 2025 08:42

@codescene-delta-analysis codescene-delta-analysis Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gates Passed
6 Quality Gates Passed

See analysis details in CodeScene

Quality Gate Profile: Clean Code Collective
Want more control? Customize Code Health rules or catch issues early with our IDE extension and CLI tool.

DevJonny pushed a commit to DevJonny/Brighter that referenced this pull request Feb 28, 2026
* feat: add a more detailed, and agent-friendly, contrib.md

* feat: remove duplication of prior headings

* feat: add more style guidelines and document src folder

* fix: don't add temp files

* feat: improve contributing.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant