[jira] [Updated] (CASSSIDECAR-227) Improve Documentation on IDE Integration

["Yuriy Semchyshyn (Jira)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/CASSSIDECAR-227?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Yuriy Semchyshyn updated CASSSIDECAR-227:
-----------------------------------------
    Change Category: Quality Assurance
         Complexity: Low Hanging Fruit
          Reviewers: Yifan Cai
             Status: Open  (was: Triage Needed)

> Improve Documentation on IDE Integration
> ----------------------------------------
>
>                 Key: CASSSIDECAR-227
>                 URL: https://issues.apache.org/jira/browse/CASSSIDECAR-227
>             Project: Sidecar for Apache Cassandra
>          Issue Type: Improvement
>          Components: Documentation
>            Reporter: Yuriy Semchyshyn
>            Assignee: Yuriy Semchyshyn
>            Priority: Minor
>          Time Spent: 10m
>  Remaining Estimate: 0h
>
> Currently, Cassandra Sidecar's {{CONTRIBUTING.md}} mentions running {{./gradlew idea}}, but does not describe the sequence of steps in detail.
> Turns out, if someone opens a freshly cloned repository in IDEA before running the command, they'll permanently lose the ability to use the preferred code formatting settings.
> Instead, the documentation shall be more clear about not opening the project manually, and the relevant section should be moved up to the top of the file.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)

---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cassandra.apache.org
For additional commands, e-mail: commits-help@cassandra.apache.org