Added Code of Conduct, contribution guidelines, issue templates. Updated readme.

Author: Miyako Jones

CODE_OF_CONDUCT.md

@@ -0,0 +1,77 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at smartsweeper@swiftlet.technology. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq
+

CONTRIBUTING.md

@@ -0,0 +1,39 @@
+# SmartSweeper Contribution Guidelines
+
+Thank you for being interested in contributing to the development of SmartSweeper.
+
+## Code of Conduct
+
+We ask that all contributors follow our [code of conduct](CODE_OF_CONDUCT.md). Please report unacceptable behavior to [smartsweeper@swiftlet.technology](mailto:smartsweeper@swiftlet.technology).
+
+## How Can I Contribute?
+### Reporting Bugs
+
+1. Please check [existing issues](/issues) to make sure the bug hasn't already been reported. If it has and the issue is still open, please add a new comment to the existing issue.
+1. If the bug hasn't been reported, create a new issue by filling in the [bug report template](docs/bug_report.md). Please include as much information as you can.
+
+### Suggesting Enhancements
+
+1. Please check [existing issues](/issues) to make sure that no one else has suggested the same enhancement. If someone has and the issue is still open, please add a new comment to the existing issue.
+1. If the suggestion hasn't already been made, please follow [these guidelines](docs/enhancement_suggestion.md).
+
+## Style Guidelines
+
+There are three styles currently in use:
+
+* ```index.js```, ```smartcashapi.js```, and ```rpc-client.js``` more-or-less follow the [Electron style guidelines](https://electronjs.org/docs/development/coding-style)
+* The other JavaScript files in general mostly follow the [W3Schools style guide](https://www.w3schools.com/js/js_conventions.asp).
+* The file and folder structure in ```/app``` follows the [John Papa's Angular 1 style guide](https://github.com/johnpapa/angular-styleguide/blob/master/a1/README.md).
+
+Going forward, all JavaScript will use the W3Schools style with an exception:
+* Conditionals:
+```javascript
+if (time < 20) {
+    greeting = "Good day";
+}
+else {
+     greeting = "Good evening";
+}
+```
+
+This guide was inspired by the [Atom contribution guidelines](https://github.com/atom/atom/blob/master/CONTRIBUTING.md).

README.md

@@ -22,29 +22,32 @@ Sweeper application for [SmartCash cryptocurrency](http://smartcash.cc) to allow
 * [Configuration](#configuration)
 * [Known issues](#known-issues)
 * [Other software used](#other-software-used)
+* [Contributing to SmartSweeper development](#contributing)
 
 
-### Installation
+## Installation
 Download a release and run the installer. You may need to run SmartSweeper as an administrator.
 
-### Running from source
-##### Additional Requirements
+
+## Running from source
+#### Additional Requirements
 * [Node.js](http://nodejs.org) - 8.9.0+
 * [npm](http://npmjs.com) - 5.6.0+
 
 Run ```node -v``` and ```npm -v``` from a command prompt to make sure both are in your PATH. Open your SmartCash node client to make sure it is synchronized before launching SmartSweeper.
 
-##### Installation
+#### Installation
 ``` bash
 npm install
 ```
 
-##### To run
+#### To run
 ``` bash
 npm start
 ```
 
-### Configuration
+
+## Configuration
 SmartSweeper can be configured by modifying .env in the root directory. The app will create it for you the first time you load it, but you can create the file yourself prior to that, which will help if you didn't use the default SmartCash installation path. The default values for Windows are shown below.
 ```
 rpc.host=127.0.0.1
@@ -83,7 +86,7 @@ rpcpassword=rpcpassword
 The values of rpc.host, rpc.port, rpc.username, and rpc.password in .env must match those in the program arguments or the smartcash.conf file.
 
 
-##### User files
+#### User files
 The database (smart-sweeper.json), the app config file (smart-sweeper-config.json), the saved dashboard data file (smart-sweeper-data.json) and the log files are saved in the following folder:
 
 * **Windows**: %APPDATA%/SmartSweeper
@@ -92,15 +95,17 @@ The database (smart-sweeper.json), the app config file (smart-sweeper-config.jso
 
 The log files are also in JSON format and can be viewed with a general log viewer such as [glogg](https://github.com/nickbnf/glogg). The user logs record user actions while the system logs record system actions and errors (and includes transaction ids and public keys).
 
-### Known issues
+
+## Known issues
 * SmartSweeper may not open the SmartCash Node Client. If smartcash.conf hasn't been modified with the info above, SmartSweeper won't work if the node client is run manually.
 * electron-store error "EPERM operation not permitted" sometimes occurs on Windows when reading a config file. SmartSweeper will exit when it does.
 * Can't connect to the node client via RPC when it's syncing (SmartSweeper will display the "Can't connect to SmartCash Node Client." error). This will cause some actions to fail and some project data updates to not occur.
 * Claimed funds info on the dashboard and the sweep funds page becomes inaccurate after one or more projects have been swept.
 * Empty log files are sometimes created in the root SmartSweeper data folder.
 * There is lag when entering text into input fields.
 
-### Other software used
+
+## Other software used
 Software | License
 -------- | --------
 [AngularJS](http://angularjs.org) | MIT
@@ -130,6 +135,10 @@ Software | License
 
 [The SmartCash Insight Explorer](https://insight.smartcash.cc) is used to check the current block count and to get information about project addresses.
 
-## Icons and graphics
+### Icons and graphics
 * Basic app icons: [Font Awesome](http://fontawesome.io)
-* Progress spinner: [preloaders.net](https://preloaders.net)
+* Progress spinner: [preloaders.net](https://preloaders.net)
+
+
+## Contributing
+You can [contribute to the development of SmartSweeper](CONTRIBUTING.md) by filing a bug report or by submitting a pull request. All contributors must follow our [code of conduct](docs/CODE_OF_CONDUCT.md).

background/background.js

@@ -26,7 +26,6 @@
     let apiCallbackCounter;
     let smartcashProg, smartcashPath, smartcash;
     let db = new Store({name: "smart-sweeper"});
-    //global.bgApiCallbackInfo = new Map(); // keeps track of API callback vars per function call
 
     init();
 

docs/bug_report.md

@@ -0,0 +1,27 @@
+## SmartSweeper Bug Report Template
+
+### Current Behavior
+A detailed description of what is currently happening.
+
+### Expected Behavior
+A detailed description of what you expected to happen.
+
+### Possible Solution
+A detailed description of what you think might fix the bug.
+
+### Steps to Reproduce
+1. 
+2. 
+3. 
+4. 
+etc.
+
+### Screenshots
+If applicable, add screenshots to help explain your problem.
+
+### Operating System and SmartSweeper version (please complete the following information):
+ - OS: [e.g. Windows 7]
+ - Version [e.g. 0.9.1]
+
+### Additional Information
+Add any other information about the problem here.

docs/pull_request_guidelines.md

@@ -0,0 +1,19 @@
+# SmartSweeper Pull Request Guidelines
+
+**IMPORTANT: Please do not create a pull request (PR) without creating an issue first.**
+
+1. Describe the enhancement
+2. Explain why the enhancement is necessary
+
+
+## How to make enhancements
+0. Create a GitHub account (if necessary).
+1. Fork then clone the repo (usually the master branch).
+2. Make your changes.
+3. Click "New pull request" on the homepage of the SmartSweeper repo.
+4. Include the following information in the request comment:
+    * What process did you follow to verify that your change has the desired effects?
+        * How did you verify that all new functionality works as expected?
+        * How did you verify that all changed functionality works as expected?
+        * How did you verify that the change has not introduced any regressions?
+    * Closes #[Issue #] in order to automatically close the related issue.

smartcashapi.js

@@ -15,7 +15,6 @@ let reqPerMin
 global.smartcashCallbackInfo = new Map() // keeps track of API callback vars per function call
 
 function init() {
-    //reqPerMin = parseInt(60 / global.sharedObject.explorerCheckInterval)
 }
 
 /* Generic API callback function. */
@@ -75,22 +74,6 @@ let smartcashCallback = function(resp, functionName, projectInfo, callback = nul
         }
 
         callback({type: 'error', msg: resp.msg}, functionName, projectInfo)
-        
-        /*if (projectInfo.projectName) {
-            var address = ""
-            if (projectInfo.address)
-                address = ", wallet address: " + projectInfo.address
-            
-            global.sharedObject.sysLogger.error('project ' + projectInfo.projectName + ', functionName' + functionName + ': ' + resp.msg)
-        }
-        else if (projectInfo.projectID) {
-            global.sharedObject.sysLogger.info(functionName + ', project #' + projectInfo.projectID)
-        }
-        else {
-            global.sharedObject.sysLogger.error(functionName + ': ' + resp.msg)
-        }*/
-        
-        
     }
 }