# Contributing to SHADI :balloon: Thanks for your help improving the project! We are so happy to have you! There are opportunities to contribute to SHADI at any level. It doesn't matter if you are just getting started with Rust or are the most weathered expert, we can use your help. **No contribution is too small and all contributions are valued.** This guide will help you get started. **Do not let this guide intimidate you**. It should be considered a map to help you navigate the process. The [dev channel][dev] is available for any concerns not covered in this guide, please join us! [dev]: https://agntcy.slack.com ## Contributing in Issues For any issue, there are fundamentally three ways an individual can contribute: 1. By opening the issue for discussion: For instance, if you believe that you have discovered a bug in SHADI, creating a new issue in [the agntcy/shadi issue tracker][issue] is the way to report it. 2. By helping to triage the issue: This can be done by providing supporting details (a test case that demonstrates a bug), providing suggestions on how to address the issue, or ensuring that the issue is tagged correctly. 3. By helping to resolve the issue: Typically this is done either in the form of demonstrating that the issue reported is not a problem after all, or more often, by opening a Pull Request that changes some bit of something in SHADI in a concrete and reviewable manner. [issue]: https://github.com/agntcy/shadi/issues **Anybody can participate in any stage of contribution**. We urge you to participate in the discussion around bugs and participate in reviewing PRs. ### Asking for General Help If you have reviewed existing documentation and still have questions or are having problems, you can [open a discussion] asking for help. In exchange for receiving help, we ask that you contribute back a documentation PR that helps others avoid the problems that you encountered. [open a discussion]: https://github.com/agntcy/shadi/discussions/new ### Submitting a Bug Report When opening a new issue in the SHADI issue tracker, you will be presented with a basic template that should be filled in. If you believe that you have uncovered a bug, please fill out this form, following the template to the best of your ability. Do not worry if you cannot answer every detail, just fill in what you can. The two most important pieces of information we need in order to properly evaluate the report is a description of the behavior you are seeing and a simple test case we can use to recreate the problem on our own. If we cannot recreate the issue, it becomes impossible for us to fix. See [How to create a Minimal, Complete, and Verifiable example][mcve]. [mcve]: https://stackoverflow.com/help/mcve ### Triaging a Bug Report Once an issue has been opened, it is not uncommon for there to be discussion around it. Some contributors may have differing opinions about the issue, including whether the behavior being seen is a bug or a feature. This discussion is part of the process and should be kept focused, helpful, and professional. Short, clipped responses-that provide neither additional context nor supporting detail-are not helpful or professional. To many, such responses are simply annoying and unfriendly. Contributors are encouraged to help one another make forward progress as much as possible, empowering one another to solve issues collaboratively. If you choose to comment on an issue that you feel either is not a problem that needs to be fixed, or if you encounter information in an issue that you feel is incorrect, explain why you feel that way with additional supporting context, and be willing to be convinced that you may be wrong. By doing so, we can often reach the correct outcome much faster. ### Resolving a Bug Report In the majority of cases, issues are resolved by opening a Pull Request. The process for opening and reviewing a Pull Request is similar to that of opening and triaging issues, but carries with it a necessary review and approval workflow that ensures that the proposed changes meet the minimal quality and functional guidelines of the SHADI project. ## Pull Requests Pull Requests are the way concrete changes are made to the code, documentation, and dependencies in the SHADI repository. Even tiny pull requests (e.g., one character pull request fixing a typo in API documentation) are greatly appreciated. Before making a large change, it is usually a good idea to first open an issue describing the change to solicit feedback and guidance. This will increase the likelihood of the PR getting merged. ## Releasing crates Rust crate releases are driven by `.github/workflows/release-rust.yml` using `release-plz`. - Public workspace crates are published to crates.io from the `main` branch release job. - The release job requires the repository secret `CARGO_REGISTRY_TOKEN` and fails early if the token is missing. - Non-publishable workspace members such as `shadi_demo_bot` are excluded from release-plz so they do not generate release tags or publish attempts. - `.github/workflows/shadictl-binaries.yml` builds and packages `shadictl` for the primary release targets on every PR and `main` push: Linux `x86_64-unknown-linux-gnu` and `aarch64-unknown-linux-gnu`, macOS `aarch64-apple-darwin` and `x86_64-apple-darwin`, and Windows `x86_64-pc-windows-msvc`. - `.github/workflows/release-rust.yml` uploads `.tar.gz` or `.zip` archives plus `.sha256` checksum files to each published `agntcy-shadi-cli-v*` GitHub release in the same workflow run that `release-plz` uses to create the release. - The hosted Linux installer at `https://agntcy.github.io/shadi/install.sh` is sourced from `docs/install.sh` and consumes the released Linux archives `shadictl-v-x86_64-unknown-linux-gnu.tar.gz` or `shadictl-v-aarch64-unknown-linux-gnu.tar.gz` plus their `.sha256` sidecars. - The Linux installer resolves the latest published `agntcy-shadi-cli-v*` release automatically unless `SHADI_VERSION` is set, so normal CLI releases do not require a per-release installer update. Only changes to asset names, supported Linux targets, or the hosting location require updates to `docs/content/install.sh` and `docs/content/install.md`. - WinGet publication uses the released Windows archive `shadictl-v-x86_64-pc-windows-msvc.zip` plus its `.sha256` sidecar as the source of truth for the WinGet installer manifest. - `scripts/render_winget_manifests.py` renders the WinGet version, default-locale, and installer manifests for `AGNTCY.shadictl` directly from a released `agntcy-shadi-cli-v*` tag. - `.github/workflows/winget-manifests.yml` can be run manually with a release tag, and `.github/workflows/release-rust.yml` calls it automatically after the release assets are uploaded so WinGet publication tracks CLI releases. - When the repository secrets `PROJECT_APP_ID` and `PROJECT_APP_KEY` are configured, `.github/workflows/winget-manifests.yml` authenticates as the project GitHub App bot, expects an existing `agntcy/winget-pkgs` fork of `microsoft/winget-pkgs`, branches from the latest `upstream/master`, commits the generated manifests, and opens or updates the upstream PR. Without those secrets, the workflow still uploads the generated manifest tree as an artifact for manual submission. - `.github/workflows/homebrew-formula.yml` opens or updates a follow-up PR that refreshes `Formula/shadictl.rb` when an `agntcy-shadi-cli-v*` release is published. ## Developer's Certificate of Origin To improve tracking of who did what, we have introduced a "sign-off" procedure. The sign-off is a line at the end of the explanation for the commit, which certifies that you wrote it or otherwise have the right to pass it on as open source work. We use the Developer Certificate of Origin (see https://developercertificate.org/) for our sign-off procedure. You must include a sign-off in the commit message of your pull request for it to be accepted. The format for a sign-off is: ``` Signed-off-by: Random J Developer ``` You can use the -s when you do a git commit to simplify including a properly formatted sign-off in your commits. If you need to add your sign-off to a commit you have already made, you will need to amend: ``` git commit --amend --signoff ``` ### Performing spellcheck on SHADI codebase You can perform spell-check on SHADI codebase. For details of how to use the spellcheck tool, feel free to visit https://github.com/drahnr/cargo-spellcheck ``` # First install the spell-check plugin cargo install --locked cargo-spellcheck # Then run the cargo spell check command cargo spellcheck check ``` if the command rejects a word, you should backtick the rejected word if it's code related. If not, the rejected word should be put into `spellcheck.dic` file. Note that when you add a word into the file, you should also update the first line which tells the spellcheck tool the total number of words included in the file ### Commits It is a recommended best practice to keep your changes as logically grouped as possible within individual commits. There is no limit to the number of commits any single Pull Request may have, and many contributors find it easier to review changes that are split across multiple commits. That said, if you have a number of commits that are "checkpoints" and don't represent a single logical change, please squash those together. Note that multiple commits often get squashed when they are landed (see the notes about [commit squashing](#commit-squashing)). #### Commit message guidelines A good commit message should describe what changed and why. 1. The first line should: * contain a short description of the change (preferably 50 characters or less, and no more than 72 characters) * be entirely in lowercase with the exception of proper nouns, acronyms, and the words that refer to code, like function/variable names * start with an imperative verb * not have a period at the end * be prefixed with the name of the module being changed; usually this is the same as the M-* label on the PR Examples: * time: introduce `Timeout` and deprecate `Deadline` * codec: export `Encoder`, `Decoder`, `Framed*` * ci: fix the arm64 ci configuration 1. Keep the second line blank. 2. Wrap all other lines at 72 columns (except for long URLs). 3. If your patch fixes an open issue, you can add a reference to it at the end of the log. Use the `Fixes: #` prefix and the issue number. For other references use `Refs: #`. `Refs` may include multiple issues, separated by a comma. Examples: - `Fixes: #1337` - `Refs: #1234` Sample complete commit message: ```txt module: explain the commit in one line Body of commit message is a few lines of text, explaining things in more detail, possibly giving some background about the issue being fixed, etc. The body of the commit message can be several paragraphs, and please do proper word-wrap and keep columns shorter than about 72 characters or so. That way, `git log` will show things nicely even when it is indented. Fixes: #1337 Refs: #453, #154 ``` ### Opening the Pull Request From within GitHub, opening a new Pull Request will present you with a [template] that should be filled out. Please try to do your best at filling out the details, but feel free to skip parts if you're not sure what to put. [template]: .github/PULL_REQUEST_TEMPLATE.md ### Discuss and update You will probably get feedback or requests for changes to your Pull Request. This is a big part of the submission process so don't be discouraged! Some contributors may sign off on the Pull Request right away, others may have more detailed comments or feedback. This is a necessary part of the process in order to evaluate whether the changes are correct and necessary. **Any community member can review a PR and you might get conflicting feedback**. Keep an eye out for comments from code owners to provide guidance on conflicting feedback. **Once the PR is open, do not rebase the commits**. See [Commit Squashing](#commit-squashing) for more details. ### Commit Squashing In most cases, **do not squash commits that you add to your Pull Request during the review process**. When the commits in your Pull Request land, they may be squashed into one commit per logical change. Metadata will be added to the commit message (including links to the Pull Request, links to relevant issues, and the names of the reviewers). The commit history of your Pull Request, however, will stay intact on the Pull Request page. ## Reviewing Pull Requests **Any agentcy community member is welcome to review any pull request**. All SHADI contributors who choose to review and provide feedback on Pull Requests have a responsibility to both the project and the individual making the contribution. Reviews and feedback must be helpful, insightful, and geared towards improving the contribution as opposed to simply blocking it. If there are reasons why you feel the PR should not land, explain what those are. Do not expect to be able to block a Pull Request from advancing simply because you say "No" without giving an explanation. Be open to having your mind changed. Be open to working with the contributor to make the Pull Request better. Reviews that are dismissive or disrespectful of the contributor or any other reviewers are strictly counter to the Code of Conduct. When reviewing a Pull Request, the primary goals are for the codebase to improve and for the person submitting the request to succeed. **Even if a Pull Request does not land, the submitters should come away from the experience feeling like their effort was not wasted or unappreciated**. Every Pull Request from a new contributor is an opportunity to grow the community. ### Review a bit at a time. Do not overwhelm new contributors. It is tempting to micro-optimize and make everything about relative performance, perfect grammar, or exact style matches. Do not succumb to that temptation. Focus first on the most significant aspects of the change: 1. Does this change make sense for SHADI? 2. Does this change make SHADI better, even if only incrementally? 3. Are there clear bugs or larger scale issues that need attending to? 4. Is the commit message readable and correct? If it contains a breaking change is it clear enough? Note that only **incremental** improvement is needed to land a PR. This means that the PR does not need to be perfect, only better than the status quo. Follow up PRs may be opened to continue iterating. When changes are necessary, *request* them, do not *demand* them, and **do not assume that the submitter already knows how to add a test or run a benchmark**. Specific performance optimization techniques, coding styles and conventions change over time. The first impression you give to a new contributor never does. Nits (requests for small changes that are not essential) are fine, but try to avoid stalling the Pull Request. Most nits can typically be fixed by the SHADI Collaborator landing the Pull Request but they can also be an opportunity for the contributor to learn a bit more about the project. It is always good to clearly indicate nits when you comment: e.g. `Nit: change foo() to bar(). But this is not blocking.` If your comments were addressed but were not folded automatically after new commits or if they proved to be mistaken, please, [hide them][hiding-a-comment] with the appropriate reason to keep the conversation flow concise and relevant. ### Be aware of the person behind the code Be aware that *how* you communicate requests and reviews in your feedback can have a significant impact on the success of the Pull Request. Yes, we may land a particular change that makes SHADI better, but the individual might just not want to have anything to do with SHADI ever again. The goal is not just having good code. ### Abandoned or Stalled Pull Requests If a Pull Request appears to be abandoned or stalled, it is polite to first check with the contributor to see if they intend to continue the work before checking if they would mind if you took it over (especially if it just has nits left). When doing so, it is courteous to give the original contributor credit for the work they started (either by preserving their name and email address in the commit log, or by using an `Author: ` meta-data tag in the commit. _Adapted from the [Tokio.rs contributing guide][tokio]_. [node]: https://github.com/tokio-rs/tokio/blob/master/CONTRIBUTING.md