Skip to content

Latest commit

 

History

History
67 lines (46 loc) · 1.75 KB

File metadata and controls

67 lines (46 loc) · 1.75 KB

Contributing

Thanks for your interest in improving the Agentic AI Learning Roadmap.

This repository is intended to be a practical curriculum with working examples, not a directory of empty project placeholders.

Good Contributions

Examples include:

  • Fixing technical inaccuracies
  • Improving setup instructions
  • Adding tests
  • Improving error handling
  • Adding a working exercise solution
  • Improving security guidance
  • Improving accessibility or clarity
  • Adding a new project when it contains a usable implementation
  • Updating an example when an upstream API has changed

Project Contribution Standard

A new project should normally include:

  • README.md
  • Working source code
  • Setup instructions
  • Dependency file
  • .env.example when configuration is required
  • Example input/output
  • Known limitations
  • Security notes
  • At least one learner exercise

Do not add an empty project folder merely to mark a roadmap item complete.

Secrets

Never include:

  • API keys
  • Access tokens
  • Passwords
  • Private credentials
  • Private datasets
  • Personally identifiable information that is not appropriate for public release

If a secret is accidentally committed, rotate it immediately. Removing it in a later commit is not sufficient because it may remain in Git history.

Pull Requests

Keep pull requests focused.

In the description, explain:

  1. What changed
  2. Why it improves the roadmap
  3. How you tested it
  4. Any security or compatibility implications

Self-Promotion

Relevant resources may be useful when they directly improve a lesson, but this repository is not intended for SEO-only submissions, link exchanges, affiliate links, or unrelated promotion.

Conduct

Be constructive, technical, and respectful when reviewing or discussing contributions.