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

Add consistent option description for --database on rails new #49594

Merged

Conversation

akhilgkrishnan
Copy link
Member

@akhilgkrishnan akhilgkrishnan commented Oct 12, 2023

Motivation / Background

To clarify the description for the --database option in the Rails new command, we are displaying the available database options separated by a forward slash (/).

[--database=DATABASE]    # Preconfigure for selected database (options: mysql/trilogy/postgresql/sqlite3/oracle/sqlserver/jdbcmysql/jdbcsqlite3/jdbcpostgresql/jdbc)

Certainly, for other options such as --javascript, --css, and --asset-pipeline, the description lists their available options separated by commas.

[--asset-pipeline=ASSET_PIPELINE]    # Choose your asset pipeline [options: sprockets (default), propshaft]
[--javascript=JAVASCRIPT]    # Choose JavaScript approach [options: importmap (default), bun, webpack, esbuild, rollup]
[--css=CSS]    # Choose CSS processor [options: tailwind, bootstrap, bulma, postcss, sass] check https://github.com/rails/cssbundling-rails for more options

Detail

This Pull Request updates --database options description with a consistent pattern.

Before submitting the PR make sure the following are checked:

  • This Pull Request is related to one change. Changes that are unrelated should be opened in separate PRs.
  • Commit message has a detailed description of what changed and why. If this PR fixes a related issue include it in the commit message. Ex: [Fix #issue-number]
  • Tests are added or updated if you fix a bug or add a feature.
  • CHANGELOG files are updated for the changed libraries if there is a behavior change or additional feature. Minor bug fixes and documentation changes should not be included.

@rails-bot rails-bot bot added the railties label Oct 12, 2023
@akhilgkrishnan akhilgkrishnan force-pushed the rails-new-database-desc-consistancy branch from ccade26 to f953178 Compare October 12, 2023 14:22
@rafaelfranca rafaelfranca merged commit 13722f2 into rails:main Oct 12, 2023
4 checks passed
@akhilgkrishnan akhilgkrishnan deleted the rails-new-database-desc-consistancy branch October 12, 2023 17:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants