Contributing as a Developer to This Project

Contributing

  1. Familiarize yourself with the codebase by reading the source code and this wiki.
  2. Create a new issue before starting your project so that we can keep track of what you are trying to add/fix. That way, we can also offer suggestions or let you know if there is already an effort in progress.
  3. Fork this repository.
  4. Development Environment Setup page has details on how to set up your environment.
  5. Create a feature branch in your fork based on the correct branch (usually the main branch). Note, this step is recommended but technically not required if contributing using a fork.
  6. Edit the code in your fork.
  7. Send us a pull request when you are done. We’ll review your code, suggest any needed changes, and merge it in.

Naming Convention

Use CamelCase to name Salesforce custom fields (e.g., SurveyDate__c).

Branches

We use GitHub-flow as branch strategy.

Pull Requests

  • Develop features and bug fixes in feature branches.
  • feature branches can live in forks (external contributors) or within this repository (committers). ** When creating feature branches in this repository please prefix with <developer-name>/.

Merging Pull Requests

  • Pull request merging is restricted to squash & merge only.

Table of contents


Back to top

Grassroots Mobile Survey is a tool built and maintained by a community of volunteers through the Open Source Commons program. This is not a Salesforce-owned product. If you need support, go to the Trailblazer Community Group.