Skip to content

Latest commit

 

History

History
134 lines (93 loc) · 2.42 KB

CONTRIBUTING.md

File metadata and controls

134 lines (93 loc) · 2.42 KB

Contributing to AgentArmy

Kiitos kiinnostuksestasi osallistua AgentArmy-projektiin! 🎉

🚀 Miten voin osallistua?

1. Raportoi bugeja

Jos löydät bugin:

  1. Tarkista onko se jo raportoitu Issues-osiossa
  2. Luo uusi Issue selkeällä otsikolla
  3. Kuvaile ongelma yksityiskohtaisesti:
    • Mitä tapahtui?
    • Mitä odotit tapahtuvan?
    • Miten voin toistaa ongelman?
    • Mikä ympäristö (OS, selain, Python-versio)?

2. Ehdota uusia ominaisuuksia

Jos sinulla on idea uudesta ominaisuudesta:

  1. Luo Feature Request -issue
  2. Kuvaile ominaisuus ja sen hyödyt
  3. Keskustele yhteisön kanssa

3. Lähetä Pull Request

  1. Forkkaa repository
  2. Luo uusi branch: git checkout -b feature/amazing-feature
  3. Tee muutoksesi
  4. Testaa muutokset
  5. Commitoi: git commit -m 'Add amazing feature'
  6. Pushaa: git push origin feature/amazing-feature
  7. Avaa Pull Request

📝 Koodaustyyli

Python (Backend)

  • Käytä PEP 8 -tyyliä
  • Maksimi rivin pituus: 100 merkkiä
  • Käytä type hintejä
  • Dokumentoi funktiot docstringeillä
def example_function(param: str) -> int:
    """
    Lyhyt kuvaus funktiosta.
    
    Args:
        param: Parametrin kuvaus
    
    Returns:
        Paluuarvon kuvaus
    """
    return len(param)

JavaScript/React (Frontend)

  • Käytä ES6+ -syntaksia
  • Käytä functional components ja hooks
  • Käytä arrow functions
  • Nimeä komponentit PascalCase:lla
const ExampleComponent = ({ prop }) => {
  const [state, setState] = useState(null);
  
  return (
    <div>
      {/* Component content */}
    </div>
  );
};

🧪 Testaus

Backend-testit

cd backend
python -m pytest tests/

Frontend-testit

cd frontend
npm test

📚 Dokumentaatio

  • Päivitä README.md jos lisäät uusia ominaisuuksia
  • Kirjoita selkeät commit-viestit
  • Kommentoi monimutkainen koodi

🔍 Code Review

Kaikki Pull Requestit käyvät läpi code reviewin. Varmista että:

  • ✅ Koodi on testattu
  • ✅ Dokumentaatio on päivitetty
  • ✅ Ei merge-konflikteja
  • ✅ CI/CD-testit menevät läpi

💬 Yhteisö

📄 Lisenssi

Osallistumalla projektiin hyväksyt että koodisi julkaistaan projektin lisenssin alaisuudessa.

Kiitos osallistumisesta! ❤️