Visualization tool for measuring onboarding effectiveness on open source projects

This tool was bult with the purpose of helping open-source maintainer to measure the effectiveness of their onboarding process, and give helpful tips on how to improve it.

spotties was built using npm.

1. Make sure you have node installed

2. Clone the repository

3. Install the project dependencies:

npm install

4. Start the local server:

npm start

4. Open your browser on the specified address (normally http://localhost:1234/index.html)

We ♥ open-source.

So if like us you want to learn or practice a skill, then come along. Help is more than wanted!

1. Look for open issues

2. Leave a comment saying you want to contribute

3. Fork this repository

4. Create your feature branch: git checkout -b #issueNumber-feature-name

5. Commit your changes (changes will only be committed if linting passes)

6. Push to the branch

7. Create a new Pull Request and wait for approval

If you've opened a pull request, but it isn't ready to be approved yet, add "WIP:" to it's title so someone else does not review and approve by accident

This project uses linting to keep a cohesive code-style, so installation of eslint and stylelint plugins for your editor/IDE are recommended.

If you don't want to install plugins, don't worry, the linter is run everytime you attemp to make a commit, and if there are any errors, you'll can see them on the terminal/command line.

If you are using another editor please add it along with it's plug-ins to the list below.

• Install linter-eslint and any other plug-in it requires
• Install linter-stylelint and any any other plug-in it requires

• 0.0.1
  • Work in progress

Hilton Pintor (@hpbl)

Renan Freitas (@rfl3)

Ricardo Barioni (@rrbarioni)

Victor Miranda (@mvictorm)

Distributed under the TBD license. See LICENSE for more information.