Skip to content

Conversation

@sei-renae
Copy link
Contributor

This pull request introduces documentation and configuration improvements to the repository. The most significant change is the addition of comprehensive GitHub Copilot instructions, which provide new contributors with clear guidance on the project structure, workflow, and best practices. Additionally, a markdownlint configuration update ensures that markdown linting ignores files in the .github directory, reducing unnecessary linting noise.

Documentation improvements:

  • Added a detailed .github/copilot-instructions.md file outlining project overview, technology stack, project structure, development workflow, coding conventions, testing requirements, documentation guidelines, data file handling, common pitfalls, API development, git workflow, and additional resources. This serves as a comprehensive onboarding and reference guide for contributors.

Tooling/configuration updates:

  • Updated .markdownlint.yml to ignore files in the .github directory, preventing markdownlint from running on workflow and configuration files.

@sei-renae sei-renae merged commit 654938c into copilot/setup-copilot-instructions Oct 29, 2025
1 check passed
@sei-renae sei-renae deleted the setup-copilot-instructions branch October 29, 2025 15:23
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.

2 participants