Adding Contributing

celador · Feb 2, 2017 · f41ae13 · f41ae13
1 parent 2f7e85a
commit f41ae13
Show file tree

Hide file tree

Showing 9 changed files with 69 additions and 27 deletions.
diff --git a/.vscodeignore b/.vscodeignore
@@ -1,13 +1,13 @@
-typings/**
-test/**
-**/*.map
-.vscode/**/*
-.gitignore
-tsconfig.json
-vsc-extension-quickstart.md
-src/**/*
-out/test/**
-**/*.js.map
-*.vsix
-out/
-.vscode-test/**
+typings/**
+test/**
+**/*.map
+.vscode/**/*
+.gitignore
+tsconfig.json
+vsc-extension-quickstart.md
+src/**/*
+out/test/**
+**/*.js.map
+*.vsix
+out/
+.vscode-test/**
diff --git a/Contributing.md b/Contributing.md
diff --git a/ForceCode-0.5.3.vsix b/ForceCode-0.5.3.vsix
diff --git a/ForceCode-0.5.4.vsix b/ForceCode-0.5.4.vsix
diff --git a/ForceCode-0.5.5.vsix b/ForceCode-0.5.5.vsix
diff --git a/ForceCode-0.5.7.vsix b/ForceCode-0.5.7.vsix
diff --git a/ForceCode-0.5.8.vsix b/ForceCode-0.5.8.vsix
diff --git a/README.md b/README.md
@@ -55,10 +55,6 @@ There's no complicated setup process or project configurations, no external apps
 * ~~Create Package.xml~~ (on hold)
     * Functionality provided by the npm [package-xml](https://www.npmjs.com/package/package-xml) package
 
-## Documentation
-
-Documentation site can be found at [https://johnaaronnelson.gitbooks.io/forcecode/content/](https://johnaaronnelson.gitbooks.io/forcecode/content/)  
-
 ## Issues
 
 Please submit any issues or feature requests to [https://github.com/celador/ForceCode/issues](https://github.com/celador/ForceCode/issues)  
@@ -197,12 +193,6 @@ Menu: &gt;Force: Save/Deploy/Compile
 Mac: alt + cmd + b  
 Win: ctrl + shift + b
 
-### Build package.xml
-
-Menu: &gt;ForceCode Menu ... Package-xml
-
-Generate a package.xml file in your src directory based on its contents. You can give the package a name, which makes your package easy to retrieve later on, or you can generate a package without a name. You can then use this package.xml to deploy your package.
-
 ### Deploy Package
 
 Menu: &gt;ForceCode Menu ... Deploy Package
@@ -237,14 +227,48 @@ Menu: &gt;Force: Get Logs
 Menu: &gt;ForceCode Menu ... Create Class  
 This will automatically create classes based on `apiVersion` else it defaults to '37.0'.
 
+### Build package.xml
+
+Menu: &gt;ForceCode Menu ... Package-xml
+
+Generate a package.xml file in your src directory based on its contents. You can give the package a name, which makes your package easy to retrieve later on, or you can generate a package without a name. You can then use this package.xml to deploy your package.
+
 **SPECIAL NOTE**  
 You can create Classes, Triggers, Components, and Pages by simply creating the file anywhere in your project structure.  
 When you save it, it'll create the file if it doesn't exist, and update it if it does.  
 The manual process doesn't automatically create the meta.xml file, so doesn't work seamlessly with CI.  However there's no easier way to connect to your org, open a file, modify it and save it back to your org.  This means working with multiple orgs is easier than ever.
 
+
+## Help Develop ForceCode 
+
+### Clone the repo
+
+Step 1.  Clone this repo to your local machine, like you would with any other Git repository.
+
+### Open the folder
+
+Step 2.  Open the folder you just created when you cloned the repo.
+
+### Install the dependencies
+
+Step 3.  Open the terminal by pressing `ctrl` + `~` and install the dependencies by running `npm install`
+
+### Run the extension
+
+Step 4.  Press F5 to start debugging the extension. A new VSCode window will open up.  Open your Salesforce project.
+
+### Debug the extension
+
+Step 5.  Find the file for the command you want to run, and put in a breakpoint. Run the command to hit the breakpoint and start exploring the variables
+
+
 ## Future goals
 
 * Test runner (kind of done)
 * Intellisense code completion (in progress)
 * Implement checkpoints in the editor
 * Integrate with Yo Force to provide scaffolding of files.
+
+## Documentation
+
+Documentation site can be found at [https://johnaaronnelson.gitbooks.io/forcecode/content/](https://johnaaronnelson.gitbooks.io/forcecode/content/)  
diff --git a/SUMMARY.md b/SUMMARY.md
@@ -4,13 +4,31 @@
 
 * [Overview](README.md#overview)
 * [Features](README.md#features)
-* [Configuration](README.md#configuration)
-* [Config](README.md#issues)
 * [Issues](README.md#issues)
+* [Configuration](README.md#configuration)
+* [Options](README.md#configuration)
 
 ## Commands
 
-* [Defining Methods](methods.md)
+* [Compile](README.md#compile)
+* [Testing](README.md#run-apex-unit-tests)
+* [Execute Anonymous](README.md#execute-anonymous)
+* [Open](README.md#open)
+* [Static Resources](README.md#bundle-and-deploy-static-resource)
+* [Deploy Package](README.md#deploy-package)
+* [Retrieve Package](README.md#retrieve-package)
+* [Get Logs](README.md#get-log)
+* [Create Class](README.md#create-class)
+
+## Backlog
+
+* [Future Goals](README.md#future-goals)
+
+## Help Improve ForceCode
 
-## Contributing
+* [Clone](Contributing.md#clone-the-repo)
+* [Open](Contributing.md#open-the-folder)
+* [Install](Contributing.md#install-the-dependencies)
+* [Run](Contributing.md#run-the-extension)
+* [Debug](Contributing.md#debug-the-extension)