[Docs] improve contributing code docs

[machichima]

Tracking issue

Why are the changes needed?

Provide more details on how to develop and debug flytekit

What changes were proposed in this pull request?

• Add instruction on using ImageSpec when running modified flytekit on remote
• Add instruction on debugging remote workflow
• Guidance for running FlyteKit integration test

How was this patch tested?

Labels

Please add one or more of the following labels to categorize your PR:

• added: For new features.
• changed: For changes in existing functionality.
• deprecated: For soon-to-be-removed features.
• removed: For features being removed.
• fixed: For any bug fixed.
• security: In case of vulnerabilities

This is important to improve the readability of release notes.

Setup process

Screenshots

Check all the applicable boxes

• I updated the documentation accordingly.
• All new and existing tests passed.
• All commits are signed-off.

Related PRs

Docs link

Summary by Bito

This pull request enhances the Flyte project's contributing documentation by clarifying the use of ImageSpec for running modified versions of flytekit in remote environments, adding debugging guidance for remote workflows, and detailing FlyteKit integration tests, thereby improving the developer experience and facilitating contributions.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (master@077a3d7). Learn more about missing BASE report.
⚠️ Report is 24 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff            @@
##             master    #6579   +/-   ##
=========================================
  Coverage          ?   58.57%           
=========================================
  Files             ?      929           
  Lines             ?    70851           
  Branches          ?        0           
=========================================
  Hits              ?    41503           
  Misses            ?    26201           
  Partials          ?     3147           

Flag	Coverage Δ
unittests-datacatalog	59.03% <ø> (?)
unittests-flyteadmin	56.09% <ø> (?)
unittests-flytecopilot	39.56% <ø> (?)
unittests-flytectl	64.64% <ø> (?)
unittests-flyteidl	76.12% <ø> (?)
unittests-flyteplugins	61.10% <ø> (?)
unittests-flytepropeller	55.06% <ø> (?)
unittests-flytestdlib	63.09% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[pingsutw]

Thank you! This is really helpful.