பராமரிப்பாளர் வழிகாட்டி#

இந்த ஆவணம் ஒரு * மேம்பாட்டாளர் * கொள்கை சலுகைகளைக் கொண்டு வரையறுக்கிறது. இங்கு விரிவான தகவல்கள் பெரும்பாலும் Qiskit வெளியீடுகள் மற்றும் பிற உள்ளார்ந்த பணிகளைத் தொடர்புபடுத்துகிறது.

நிலையான கிளை கொள்கை#

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

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

  • பயனர் தெரிவுநிலை நன்மை: பயனர்கள் உண்மையில் கவனிக்கக்கூடிய ஒன்றை நாம் சரிசெய்கிறோமா, அப்படியானால், அது எவ்வளவு முக்கியம்?

  • பிழைத்திருத்தம் எவ்வாறு தன்னியக்கமானது: இது ஒரு குறிப்பிடத் தக்க சிக்கலைச் சரிசெய்தாலும், நிறைய குறியீட்டை மாற்றியமைத்தால், குறைவான ஆபத்தான பிழைத்திருத்தம் எப்படி இருக்கும் என்பதைப் பற்றிச் சிந்திக்க வேண்டியது அவசியம்.

  • Whether the fix is already on main: a change must be a backport of a change already merged onto master, unless the change simply does not make sense on master.

Backporting#

When a PR tagged with stable backport potential is merged, or when a merged PR is given that tag, the Mergify bot will open a PR to the current stable branch. You can review and merge this PR like normal.

ஆவண அமைப்பு#

The way documentation is structured in Qiskit is to push as much of the actual documentation into the docstrings as possible. This makes it easier for additions and corrections to be made during development, because the majority of the documentation lives near the code being changed.

Refer to https://qiskit.github.io/qiskit_sphinx_theme/apidocs/index.html for how to create and write effective API documentation, such as setting up the RST files and docstrings.