Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Compiler Issues Documentation #13

Open
3 tasks
neotheprogramist opened this issue Oct 3, 2023 · 0 comments
Open
3 tasks

Compiler Issues Documentation #13

neotheprogramist opened this issue Oct 3, 2023 · 0 comments
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@neotheprogramist
Copy link
Member

Background

During the development of our Rust SDK as outlined in the previous issue, we encountered specific compiler issues. To benefit the broader developer community and our team, we plan to document these issues comprehensively.

Objective

  1. Tagging or branching out specific versions where compiler issues were encountered.
  2. Creating a comprehensive README that describes each compiler issue, proposes the ideal behavior, and suggests possible fixes.

Requirements

  • Identify all instances where compiler issues arose during the development process.
  • Create dedicated tags or branches for each identified compiler issue.
  • For each tag/branch, draft a README section that:
    • Describes the encountered compiler issue.
    • Proposes how the compiler ideally should have behaved.
    • Suggests potential fixes or workarounds.

Expected Outcome

  • All encountered compiler issues will be well-documented, providing insights and guidance for developers facing similar challenges.
  • The repository will serve as an invaluable resource, shedding light on potential pitfalls and their resolutions during Rust SDK development.
@neotheprogramist neotheprogramist added bug Something isn't working documentation Improvements or additions to documentation labels Oct 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants