Skip to content

Docs: Quickstart test run + --via-ir optimizer example #16156

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

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from

Conversation

aryanrahar
Copy link

This PR adds two small, newcomer-friendly docs improvements:

Contributing: a “Quickstart: build & run tests once” snippet so first-time contributors can verify their environment quickly.

Using the compiler: a minimal example showing solc --via-ir used with --optimize and --optimize-runs.

Files changed

docs/contributing.rst — quickstart test run block

docs/using-the-compiler.rst — --via-ir + optimizer example (--optimize-runs=1)

Why
New contributors often look for a single command to build & run tests, and many are unsure how --via-ir interacts with optimizer flags. These short, concrete snippets reduce setup friction and align with current usage.

Verification

Built docs locally with:

./docs/docs.sh
✅ Passed (no warnings/errors).

Scope
Docs-only. No changes to compiler code or behavior.

Notes for reviewers
Happy to adjust placement/wording if you prefer a different section heading or example contract.

Copy link

github-actions bot commented Aug 8, 2025

Thank you for your contribution to the Solidity compiler! A team member will follow up shortly.

If you haven't read our contributing guidelines and our review checklist before, please do it now, this makes the reviewing process and accepting your contribution smoother.

If you have any questions or need our help, feel free to post them in the PR or talk to us directly on the #solidity-dev channel on Matrix.

@clonker
Copy link
Member

clonker commented Aug 8, 2025

You added your entire venv to the PR. Please fix :)

@aryanrahar
Copy link
Author

You added your entire venv to the PR. Please fix :)

Thanks for the heads-up! I removed the accidental .venv and added it to .gitignore. The PR now only contains the two docs changes. CI should be happier now.

@aryanrahar
Copy link
Author

all the check have successfully passed!!!

@clonker
Copy link
Member

clonker commented Aug 11, 2025

Now your proposed change is gone from the PR (if it was ever there at least), you added some things to the .gitignore - which is unnecessary -, and the commit with your venv is still in the branch. Depending on the size of your example it might be better to propose it here: #16095
Otherwise, please fix, so I can have a look at it or just post it here in the comments. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants