Wybierz publiczny projekt i twierdzenie
Zacznij od konkretnego publicznego repozytorium swojego projektu lub organizacji, którą badasz. Skopiuj pełną nazwę właściciela i repozytorium. Zapisz dokładne stwierdzenie o funkcji, które chcesz znaleźć, i odróżnij dokumentację od testu implementacji.
Użyj tej procedury, aby znaleźć dokumentację projektu. Nie szukaj ujawnionych danych uwierzytelniających, prywatnych informacji kontaktowych ani sposobów obejścia kontroli dostępu do repozytorium.
Używaj kwalifikatorów wyszukiwania kodu świadomie
Dokumentacja wyszukiwania kodu GitHub wyjaśnia, że samo słowo może pasować zarówno do ścieżki pliku, jak i do jego treści. repo: ogranicza wyszukiwanie do pełnej nazwy właściciela/repozytorium, path: zawęża ścieżki, a content: wymaga wystąpienia terminu w treści pliku. Cudzysłowy pozwalają szukać dokładnego sformułowania. Te zasady dotyczą wyszukiwania kodu, a nie automatycznie zgłoszeń (issues) ani wyszukiwania profili. Źródło
Dla przykładowego repozytorium o nazwie example-owner/example-project zapytanie mogłoby wyglądać tak:
repo:example-owner/example-project content:"export format"Nazwy i fraza są symbolami zastępczymi, a nie rzeczywistym wyszukiwaniem, które przeprowadziliśmy. Zastąp je repozytorium, które masz uprawnienia do przeglądania, oraz sformułowaniem odpowiednim do twojego pytania. Jeśli wiesz, że pliki znajdują się w ścieżce dokumentacji, dodaj odpowiednie ograniczenie path:; w przeciwnym razie pomiń to założenie.
Zinterpretuj dopasowanie, zanim je zacytujesz
| Wynik | Co sprawdzić | Czego to nie dowodzi |
|---|---|---|
| Pasująca nazwa pliku | Czy fraza występuje w treści | Że plik potwierdza stwierdzenie |
| Fragment dokumentacji | Pobliskie informacje o wersji i zastrzeżenia dotyczące funkcji | Że opisana funkcja została przetestowana |
| Przykład lub propozycja | Czy opisuje zachowanie planowane lub ilustracyjne | Że funkcjonalność została wydana |
| Pusty wynik | Repozytorium, typ zapytania i ograniczenia | Że twierdzenie nigdy nigdzie nie istniało |
GitHub dokumentuje wymóg zalogowania się do wyszukiwania kodu we wszystkich publicznych repozytoriach. Odróżnia też witrynę GitHub Pages od treści źródłowej repozytorium. Źródło Zapisz rzeczywisty obszar wyszukiwania i ograniczenia dostępu; nie omijaj wymogu zalogowania i nie traktuj nieprzeszukanej witryny jako objętej.
Powiąż fragment z wersją
Otwórz plik i przeczytaj cały odpowiedni fragment. Przypisz udokumentowane twierdzenie do projektu. Nie uruchamiaj kodu repozytorium tylko po to, aby ukończyć to zadanie czytania, i nie wnioskuj o niezawodności produktu na podstawie gwiazdek lub nazw kont.
Gdy znajdziesz właściwy fragment, postępuj zgodnie z przewodnikiem po trwałych linkach GitHub, aby zachować sprawdzoną wersję. Następnie lista kontrolna przeglądu źródeł AI pomaga oddzielić stwierdzenie z tego dokumentu od wniosków dodanych przez model.