Δώστε στον agent χρήσιμο πλαίσιο από το αποθετήριο
ΟλοκληρώθηκεΠαρέχετε τρέχουσες οδηγίες, σχετικό κώδικα και λειτουργικές εντολές ελέγχου χωρίς να εκθέτετε περιττές πληροφορίες.
Εκδότης TaigaΠώς γράφουμε
Ελέγξτε τι κατανοήσατεΟ οδηγός του αποθετηρίου προτείνει μια εντολή που δεν υπάρχει πλέον. Τι πρέπει να κάνει ο agent;Κάντε την άσκηση
Τι θα μάθετε
- Προετοιμάστε ένα εστιασμένο σύνολο πληροφοριών για μια εργασία αποθετηρίου.
- Εντοπίστε παρωχημένες ή αντικρουόμενες οδηγίες.
- Κρατήστε τα διαπιστευτήρια και τα άσχετα ιδιωτικά δεδομένα έξω από το πλαίσιο της εργασίας.
Ξεκινήστε από το τρέχον checkout
Ο agent χρειάζεται να γνωρίζει ποιο αποθετήριο και branch αλλάζει. Χρειάζεται επίσης να γνωρίζει αν ο κατάλογος εργασίας περιέχει άσχετες αλλαγές. Αυτά τα στοιχεία επηρεάζουν τι μπορεί να επεξεργαστεί με ασφάλεια και πώς πρέπει να ερμηνευτεί το τελικό diff.
Ζητήστε από τον agent να εξετάσει τις οδηγίες του έργου και τη διαμόρφωση πακέτων πριν από την υλοποίηση. Μια εντολή που θυμάται από άλλο αποθετήριο μπορεί να είναι λανθασμένη εδώ. Ένα γνωστό όνομα framework δεν αποδεικνύει την εγκατεστημένη έκδοση ή τις συμβάσεις του έργου.
Για μια μικρή αλλαγή, παρέχετε το σχετικό module, τον κώδικα που το καλεί, τα tests και την απόφαση αρχιτεκτονικής. Προσθέστε πληροφορίες όταν η διερεύνηση δείξει συγκεκριμένη ανάγκη.
Χρησιμοποιήστε τις οδηγίες αποθετηρίου για σταθερούς κανόνες
Ένα αρχείο οδηγιών μπορεί να περιγράφει υποστηριζόμενες εντολές, όρια modules, απαιτήσεις ανασκόπησης και ενέργειες που απαιτούν απόφαση υπευθύνου. Η σύμβαση AGENTS.md δίνει στα εργαλεία προγραμματισμού αναγνωρίσιμη θέση για αυτές τις πληροφορίες. Η υποστήριξη εργαλείων και η προτεραιότητα οδηγιών μπορεί να διαφέρουν, επομένως ελέγξτε τη συμπεριφορά του εργαλείου σας.
Κρατήστε τους σταθερούς κανόνες του έργου στο αποθετήριο. Κρατήστε την τρέχουσα εργασία στην περιγραφή εργασίας. Μη μετατρέπετε το αρχείο οδηγιών σε ιστορικό κάθε συνομιλίας ή λίστα προσωρινών σχεδίων.
Μια χρήσιμη οδηγία λέει: «Εκτελέστε τα integration tests εξουσιοδότησης όταν ένα route αλλάζει τη συμπεριφορά πρόσβασης». Μια αόριστη οδηγία λέει: «Να προσέχετε πάντα την ασφάλεια». Η πρώτη προσδιορίζει έναυσμα και ενέργεια που μπορεί να επαληθεύσει ο αξιολογητής.
Ελέγξτε τις οδηγίες σε σχέση με τον κώδικα
Οι οδηγίες γίνονται παρωχημένες όταν αλλάζουν οι εντολές, οι κατάλογοι ή η αρχιτεκτονική. Αν ένας οδηγός ονομάζει script που λείπει, εξετάστε τη διαμόρφωση πακέτων. Αν ένα έγγραφο λέει ότι μια υπηρεσία είναι μόνο για ανάγνωση, εξετάστε τα δικαιώματα πριν βασιστείτε σε αυτόν τον ισχυρισμό.
Καταγράψτε τη σύγκρουση. Χρησιμοποιήστε άμεσα αποδεικτικά στοιχεία για την τρέχουσα έκδοση ώστε να κατανοήσετε τη συμπεριφορά της υλοποίησης. Μην απορρίπτετε σιωπηρά μια σκόπιμη πολιτική επειδή ο παλιός κώδικας την παραβιάζει. Η πολιτική και η τρέχουσα συμπεριφορά απαντούν σε διαφορετικά ερωτήματα.
Για παράδειγμα, ο οδηγός μπορεί να απαγορεύει άμεσες εγγραφές σε κοινόχρηστο branch, ενώ ένα παλιό script εξακολουθεί να τις εκτελεί. Η σωστή απόκριση είναι να διατηρηθεί η πολιτική και να διορθωθεί το script. Ο υπάρχων κώδικας δεν δίνει άδεια επανάληψης μιας απαγορευμένης ενέργειας.
Κρατήστε το πλαίσιο σχετικό και ασφαλές
Ένα ολόκληρο αποθετήριο μπορεί να περιέχει διαπιστευτήρια, ιδιωτικά fixtures, εξαγωγές πελατών και παλιά logs υποστήριξης. Η πρόσβαση στο αποθετήριο δεν καθιστά αυτόματα κάθε αρχείο κατάλληλο για μια υπηρεσία μοντέλου.
Χρησιμοποιήστε εγκεκριμένα εργαλεία και κανόνες χειρισμού δεδομένων. Αποκλείστε τα μυστικά από το πλαίσιο. Αντικαταστήστε τα παραδείγματα πελατών με επινοημένα δεδομένα όπου είναι δυνατόν. Ελέγξτε τα συνδεδεμένα εργαλεία, όχι μόνο τα μεταφορτωμένα αρχεία: ένας connector αναζήτησης μπορεί να ανακτήσει πληροφορίες που δεν υπήρχαν ποτέ στο αρχικό prompt.
Μια οδηγία αποθετηρίου που λέει «μη διαβάζετε μυστικά» είναι χρήσιμη καθοδήγηση. Δεν υποκαθιστά τον περιορισμό πρόσβασης στον χώρο αποθήκευσης μυστικών και σε ευαίσθητους καταλόγους.
Αφήστε χρήσιμη καταγραφή για τον επόμενο άνθρωπο
Κατά την ολοκλήρωση, καταγράψτε την αλλαγμένη συμπεριφορά, την επαλήθευση και τους ανεπίλυτους περιορισμούς στο pull request. Ενημερώστε τη μόνιμη τεκμηρίωση του έργου όταν αλλάζει η υποστηριζόμενη ροή εργασίας. Αποφύγετε την αντιγραφή ολόκληρης της συνομιλίας του agent στο αποθετήριο.
Η καταγραφή πρέπει να βοηθά έναν μελλοντικό συντηρητή να επαναλάβει την εργασία χωρίς να ανασυνθέτει μια μεγάλη συνομιλία. Συνδέστε την με τα επίσημα έγγραφα αναφοράς και κρατήστε μία έγκυρη περιγραφή για κάθε σταθερό κανόνα.
Το καλό πλαίσιο μειώνει την επαναλαμβανόμενη διερεύνηση. Κάνει επίσης τα λάθη ευκολότερα στον εντοπισμό, επειδή η αναμενόμενη συμπεριφορά και οι λειτουργικές εντολές είναι ρητές.
Κάντε την άσκηση
Εξετάστε ένα αρχείο οδηγιών αποθετηρίου. Επαληθεύστε τρεις εντολές στο τρέχον έργο. Βρείτε μία παρωχημένη δήλωση ή έναν περιορισμό που λείπει. Προτείνετε μικρή διόρθωση μέσω της κανονικής διαδικασίας ανασκόπησης. Μη συμπεριλάβετε διαπιστευτήρια ή δεδομένα πελατών.
Λήψη φύλλου εργασίας (Markdown)Η κατάργηση αυτής της επιλογής διαγράφει όλη την πρόοδο που έχει αποθηκευτεί σε αυτόν τον browser.
Η πρόοδος παραμένει σε αυτό το πρόγραμμα περιήγησης. Χωρίς λογαριασμό ή παρακολούθηση.