ஒரு நல்ல இணைப்பு எழுதுதல்

தனி மாற்றங்களை எழுதுங்கள்

11 ஒற்றைப்படை சிக்கல்களை சரிசெய்வதாகக் கூறப்படும் ஒரு பெரிய பேட்சைப் பெறும்போது அது எரிச்சலூட்டுகிறது, ஆனால் விவாதங்களும் கருத்துக்களும் அவர்களில் 10 பேருடன் உடன்படவில்லை அல்லது அவர்களில் 9 பேர் ஏற்கனவே வித்தியாசமாக சரி செய்யப்பட்டுள்ளனர். இந்த மாற்றத்தை ஒன்றிணைக்கும் நபர் ஒற்றை சுவையான இணைப்பை எங்காவது இருந்து பிரமாண்டமான ஆதாரங்களின் குவியலுக்குள் பிரித்தெடுக்க வேண்டும், மேலும் இது நிறைய கூடுதல் வேலைகளை உருவாக்குகிறது.

முன்னுரிமை, ஒரு சிக்கலை நிவர்த்தி செய்யும் ஒவ்வொரு பிழைத்திருத்தமும் அதன் சொந்த விளக்கில் இருக்க வேண்டும்/அதன் சொந்த விளக்கத்துடன்/செய்திகளை அவர்கள் சரிசெய்ததை சரியாகக் குறிப்பிட வேண்டும், இதனால் அனைத்து மாற்றங்களும் பராமரிப்பாளர் அல்லது பிற ஆர்வமுள்ள தரப்பினரால் தேர்ந்தெடுக்கப்பட்டதாகப் பயன்படுத்தப்படலாம்.

மேலும், தனித்தனி மாற்றங்கள் எதிர்காலத்தில் சிக்கல்களையும் பின்னடைவையும் கண்காணிக்க மிகவும் சிறப்பாக பிரிக்க உதவுகின்றன.

ஆவணப்படுத்துதல்

ஆவணங்கள் ஒரு கடினமான பணியாக இருக்கலாம்; இருப்பினும், யாராவது அதை முடிக்க வேண்டியது தேவை. குறியீடு மாற்றங்களுடன் ஆவணங்களை நீங்கள் சமர்ப்பித்தால் அது விசயங்களை மிகவும் எளிதாக்குகிறது. ஆவண முறைகள், சிக்கலான குறியீடு தொகுதிகள் அல்லது பயனர் காணக்கூடிய அம்சங்களுக்கு நினைவில் கொள்க.

சோதனை வழக்குகள்

சோதனைகள் நற்பொருத்தங்கள் அவை செயல்படுகின்றன என்பதை விரைவாக சரிபார்க்க அனுமதிக்கின்றன. இந்த சூழ்நிலையை பராமரிக்கவும், அதை மேம்படுத்தவும், சேர்க்கப்பட்ட அனைத்து புதிய நற்பொருத்தங்கள் மற்றும் செயல்பாடுகள் சோதனை தொகுப்பில் சோதிக்கப்பட வேண்டும். சேர்க்கப்பட்ட ஒவ்வொரு அம்சமும் குறைந்தது ஒரு செல்லுபடியாகும் சோதனை வழக்கைப் பெற வேண்டும், அது ஆவணப்படுத்தப்பட்டதாக செயல்படுகிறது என்பதை சரிபார்க்கிறது.

செய்திகளைச் செய்யுங்கள்

Git கமிட்கள் Conventional Commits விவரக்குறிப்பைப் பின்பற்ற வேண்டும்.

வகை சரிபார்த்தல்

எந்த புதிய குறியீடும் PEP 484 வகை குறிப்புகளைப் பயன்படுத்த வேண்டும். சாங்கோ பயன்பாடுகளின் வகைச் சரிபார்ப்பை நடைமுறைப்படுத்தும் சாங்கோ செருகுநிரலைக் கொண்டிருப்பதால், அவற்றைச் சரிபார்க்க நாங்கள் mypy ஐப் பயன்படுத்துகிறோம்.

புதிய மற்றும் மாற்றப்பட்ட குறியீடு புதிய mypy தோல்விகளை அறிமுகப்படுத்தக்கூடாது, அங்கு தற்போதைய சாங்கோ தட்டச்சு உதவி அதை நடைமுறைப்படுத்துகிறது. குறியீட்டு அடிப்படையானது வகை சிறுகுறிப்புகளால் இன்னும் முழுமையாக மூடப்படவில்லை, மேலும் சில சாங்கோ கட்டுமானங்கள் துல்லியமாக சிறுகுறிப்பு செய்வது கடினம். எனவே தொஒ தேர்ந்தெடுக்கப்பட்ட தொகுதிகளுக்கு மட்டும் mypy ஐ செயல்படுத்துகிறது மற்றும் பிற கண்டுபிடிப்புகளை தனித்தனியாக தெரிவிக்கிறது.

குறியீட்டு மற்றும் குறியீட்டைக் குறைத்தல்

குறியீடு PEP 8 குறியீட்டு வழிகாட்டுதல்களைப் பின்பற்ற வேண்டும் மற்றும் ruff குறியீடு வடிவமைப்பைப் பயன்படுத்தி வடிவமைக்கப்பட வேண்டும்.

குறியீட்டின் தரத்தை சரிபார்க்க, நீங்கள் ruff ஐப் பயன்படுத்தலாம், அதன் கட்டமைப்பு pyproject.toml இல் சேமிக்கப்படும்.

When suppressing a ruff diagnostic, prefer # ruff: ignore[rule-name] with the human-readable rule name. Place the comment on the line above the logical statement or block when that does not broaden the suppression scope. Keep the comment inline when moving it would change the scope, affect import sorting, or get between another tool's disable-next comment and the code it targets.

இவை அனைத்தையும் செயல்படுத்த எளிதான அணுகுமுறை prek ஐ நிறுவுவது. இது வலைபெயர்ப்பு பயன்படுத்தும் pre-commit கருவியின் மூன்றாம் தரப்பு மறுசீரமைப்பு ஆகும். இது pyproject.toml இல் அறிவிக்கப்பட்ட வளர்ச்சி சார்புகளில் சேர்க்கப்பட்டுள்ளது, எனவே அந்த சார்புகளை நிறுவுவது prek கிடைக்கும்.

எல்லா கோப்புகளையும் கைமுறையாக சரிபார்க்க, இயக்கவும்:

uv run prek run --all-files

அசல் pre-commit கிளையண்டை நீங்கள் விரும்பினால், அது .pre-commit-config.yaml இலிருந்து அதே உள்ளமைவைப் பயன்படுத்துகிறது.

பாதுகாப்பாக குறியீட்டு

Weblateக்கான எந்தக் குறியீடும் வடிவமைப்புக் கோட்பாடுகளின் பாதுகாப்பு என்பதை மனதில் வைத்து எழுத வேண்டும்.

AI வழிகாட்டுதல்கள்

திட்டத்திற்கு உள்ளடக்கத்தை பங்களிக்கும்போது, அதைப் பயன்படுத்த எங்களுக்கு இசைவு அளிக்கிறீர்கள், அதை எங்களுக்கு விநியோகிக்க நீங்கள் அனுமதிக்கப்படுவதை உறுதிசெய்கிறீர்கள். எங்களுக்கு ஒரு மாற்றத்தை சமர்ப்பிப்பதன் மூலம், மாற்றங்கள் திட்டத்தால் ஏற்றுக்கொள்ளப்படலாம் மற்றும் ஏற்றுக்கொள்ளப்பட வேண்டும் என்பதை ஒப்புக்கொள்கிறீர்கள் மற்றும் திட்ட உரிமத்தின் கீழ் மறுபகிர்வு செய்யப்பட வேண்டும். உரிமம் பெறாத குறியீடு எதுவும் திட்டத்திற்கு சமர்ப்பிக்கப்படவில்லை என்பதை உறுதிப்படுத்த சுமை அவர்கள் மீது உள்ளது என்பதை ஆசிரியர்கள் வெளிப்படையாக அறிந்திருக்க வேண்டும்.

இது AI பயன்படுத்தப்படுகிறதா இல்லையா என்பதிலிருந்து சுயாதீனமாக உள்ளது.

ஒரு இழுப்பு கோரிக்கையை பங்களிக்கும்போது, நிச்சயமாக, முன்மொழிவு நல்ல தகுதி வாய்ந்தது என்பதையும், எங்கள் வழிகாட்டுதல்களைப் பின்பற்றும் சிறந்த முயற்சி என்பதையும் நீங்கள் எப்போதும் உறுதிப்படுத்த வேண்டும். கட்டைவிரல் ஒரு அடிப்படை விதி என்னவென்றால், AI இன் உதவியுடன் பங்களிப்பு செய்யப்பட்டது என்பதை யாராவது கண்டுபிடிக்க முடிந்தால், உங்களுக்கு அதிக வேலை இருக்கிறது.

திட்டத்தில் AI உதவியுடன் எழுதப்பட்ட குறியீட்டை நாங்கள் ஏற்றுக்கொள்ளலாம், ஆனால் குறியீடு இன்னும் குறியீட்டு தரங்களைப் பின்பற்ற வேண்டும், தெளிவாக எழுதப்பட வேண்டும், ஆவணப்படுத்தப்பட வேண்டும், அம்ச சோதனை வழக்குகள் மற்றும் நம்மிடம் உள்ள அனைத்து சாதாரண தேவைகளையும் பின்பற்ற வேண்டும்.