Skip to content

chore: add contributing guide#3

Merged
johnnygreco merged 8 commits into
mainfrom
johnny/add-contributing-guide
Nov 3, 2025
Merged

chore: add contributing guide#3
johnnygreco merged 8 commits into
mainfrom
johnny/add-contributing-guide

Conversation

@johnnygreco

Copy link
Copy Markdown
Contributor

No description provided.

@johnnygreco johnnygreco changed the title add guide add contributing guide Oct 30, 2025
Comment thread CONTRIBUTING.md Outdated

1. **[README.md](README.md)** – best place to start to learn the basics of the project

2. **[AGENTS.md](AGENTS.md)** – code structure and development guidelines for humans and agents

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Can we add a bit more on what this is for?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Perhaps we only say for agents?
following the standards defined in https://agents.md/

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Yeah, I was just thinking it is also a great place for humans to get a quick overview of code style / preferences / etc

I don't think we need to say much here, though. It's becoming a pretty standard.

@johnnygreco johnnygreco Oct 31, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

What about this ea62410

Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md
@johnnygreco johnnygreco changed the title add contributing guide chore: add contributing guide Oct 31, 2025
@johnnygreco johnnygreco force-pushed the johnny/add-contributing-guide branch 7 times, most recently from 804c0ef to bb04429 Compare October 31, 2025 20:31
@johnnygreco johnnygreco force-pushed the johnny/add-contributing-guide branch from bb04429 to a3d3365 Compare October 31, 2025 21:34

@nabinchha nabinchha left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🚢

@johnnygreco johnnygreco merged commit 067ecb4 into main Nov 3, 2025
10 checks passed

@kirit93 kirit93 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks good to me!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants