Skip to content

Custom Template README.md Not Reflected in Generated Project #646

Description

@hrk623

Summary

I created a custom template following the Custom Code Templates documentation to standardize the README.md format across projects in our team. However, the README.md content is not reflected in the generated project.

I maintained the folder structure as described in the documentation and modified the README.md inside the standard template folder before creating a new project. Despite this, the README.md in the generated project still contains the original content from this repository instead of my custom template.

Since the Apex class was correctly applied from the custom template, I believe the configuration is not the issue. I was unsure whether to classify this as a bug or a feature request, but I am reporting it as a bug first.

Steps To Reproduce:

  1. Clone this repository to local and set the path to sf config
cd /Users/[USER_NAME]/.sf
git clone https://github.com/forcedotcom/salesforcedx-templates.git  
sf config set org-custom-metadata-templates=/Users/[USER_NAME]/.sf/salesforcedx-templates/src/templates --global
  1. Modify salesforcedx-templates/src/templates/project/standard/README.md
  2. Create a new project with VS Code command palette

Expected result

A new project is created with the README.md from custom template.

Actual result

A new project is created with the README.md from this repository.

Additional information

VS Code Version:
Version: 1.96.3

SFDX CLI Version:
@salesforce/cli/2.74.6

OS and version:
macOS Sequoia Version 15.2

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions