Get Ready to Contribute
How to get set up to work with the Salesforce Indicators repo and Salesforce Indicators app.
All contributions to this project are welcome and encouraged.
If you are coming to a sprint, we don’t want you to get discouraged because one quarter of the sprint is taken with getting set up. So it’s great if you can get set up before the sprint so you can start working within the first hour. If you have any questions about any of these steps, please get in touch before the Sprint day.
Admin Focused Contributions
- Get to know Salesforce Indicators by reading this Documentation Site. (check the YouTube video also).
- Get an org set up, preferably NPSP.
- Install Nonprofit Success Pack (NPSP) into a Trailhead Playground.
- Or create a Scratch Org (with Sample Data) and install NPSP using Metadeploy.
- Install Salesforce Indicators in your Trailhead Playground or Scratch Org
- This will also install the Sample Indicators.
- Go to a Contact record, modify the Lightning Page, and see that the Indicators Component is on the Page.
- Modify an Indicator - see the Indicator Item help doc.
- At one stage during the Sprint we may ask you to download your Custom Metadata, the easiest way is to install Salesforce Inspector Chrome Extension.
- Ensure you are able to log into the Github Documentation Repo (Ask one of the team to be added the Repo first).
- Let the team know in the Slack Channel what you would like to work on.
- Have Fun!
- Take it further:
- Think about any of these steps you have done (especially installing, and setting up Indicators) and make notes as to how you can improve the help docs, and go ahead and modify the documentation (once you have access and have been shown how to!).
- For tips for others on how to get any of the rest of this set up, then please modify this document to add any hints and tips.
Documentation Update
More details on how to modify the documentation pages via a Pull Request.
Development Contributions
- Let the team know, so we can do a more in-depth setup with you and ensure you are set up in Github.
- Get to know Salesforce Indicators by reading this Documentation Site. (check the YouTube video also).
- Ensure you have VSCode set up.
- It would be handy to have Cumulus CI installed, but not 100% necessary.
- Clone the repo to your local environment. Ensure you use the
Mainbranch - Create a Scratch Org.
- Optionally install NPSP (not needed for development though).
- Deploy the repo into your Scratch Org.
- Include the Samples setup and data (Unpackaged Folder) in your deployment.
- Assign the Permission Set Indicators Setup Access to your Salesforce Administrator user - this will show the Indicators Setup Tab for your user.
- Go to a Contact record, modify the Lightning Page, and see that the Indicators Component is on the Page.
- Modify an Indicator (see the Setup Video)
- Ensure you are able to log into the Github Documentation Repo and the Salesforce Indicators Repo (Ask one of the team to be added the Repo first).
- Grab an issue from the Issues list and assign it to yourself.
- Have Fun!
- Take it further:
- Think about any of these steps you have done (especially installing, and setting up Indicators) and make notes as to how you can improve the help docs, and go ahead and modify the documentation (once you have access and have been shown how to!).
- For tips for others on how to get any of the dev environments set up, then please modify this document to add any hints and tips.
Hints and Tips for Devs
To test a branch in a Sandbox, developer, or scratch org, you can download directly from the repo into VSCode and deploy from there, or use this Button to deploy a specific branch to your Salesforce org. Be sure to enter main as the branch name or it will deploy the old “master” branch as default.
- If deploying to a scratch org, remember to select the “Deploy to Sandbox” option.
- If you need to uninstall, you need to remove the component and code manually.