Skip to content
Kai Xu edited this page May 12, 2017 · 26 revisions

Welcome to the SenseMapExtension wiki!

If this is your first time involved in the SenseMap development, the information below will get you started:

  1. If you haven't done any Chrome extension development before, have a look of the tutorial;

  2. We use Git a lot (this is GitHub anyway :-). If you are not familiar with it, there are many good tutorials, such as https://www.atlassian.com/git/tutorials and https://try.github.io/. The most important part is the 'collaborating', as you will be working in a team. More details about the SenseMap branch structure and how to add your the changes here.

  3. We are using Behaviour-Driven Development (BDD), which is closely related to unit testing. There are more details here.

  4. Now, you are almost ready. Before diving into the coding, have a look of the SenseMap architecture and existing bugs and planned features in the issues.

  5. Now you are ready! Make sure to follow the development process mentioned in the Summary section on the BDD and testing page:

    1. Create the use case or user story (as a wiki page, until we find a better way);
    2. Create the test suites and specs (using Jasmine) based on the user case or user story;
    3. Write the JS code according to use case/user story;
    4. Use Sinon-Chrome to create the test doubles of chrome api and any other external functions needed;
    5. Make sure the JS code passes all the unit tests.

Have fun!

Clone this wiki locally