Permalink
Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
56 lines (32 sloc) 2.9 KB

Contributing

I have a vision for historical modeling, but I need your help to realize this vision in JavaScript. Here are some of the ways you can help.

Building

Clone the repository and build the code. You will need to:

Once:

Each time you pull:

  • Run "tsd reinstall"
  • Run "tsd rebundle"
  • Run "npm install"
  • Run "bower install"

As you work:

  • Run "grunt" to compile and run the tests
  • Run "grunt watch" to start the watcher that will compile and run tests

Testing

Follow the instructions in the ImprovingU Jinaga sample app. Create your own application using Jinaga, and let me know what issues you find. Open issues in this repository.

Roadmap

The large steps to achieve the vision of Historical Modeling in JavaScript and beyond are documented in the Jinaga Roadmap. Please look through that document to decide where you want to help out.

Recommendations

Create issues for anything you would like to see changed in the roadmap. We will discuss it in the public arena. Keep in mind, however, that recommendations for changes are to be defended. Be prepared to provide evidence that it makes the system more resilient, more secure, or easier to use. Personal preference is not evidence.

Sending pull requests

Before making large changes, please let me know what you are working on. Comment on an issue, or open a new one.

Clone the repository in GitHub. Create a branch. Make your changes. Submit a pull request from your working branch against master.

If you prefer some other repository host, please open an issue and paste in your git URL and working branch name.

Asking questions

Reach out to me on Twitter @michaellperry. Ask me about the library in particular, or historical modeling in general.

Spreading the word

When you talk about the project, you can send people to http://jinaga.com. That will take them to this repository until I create a home page for the library. Then it will take them to documentation on getting started and a reference manual.

When you talk about historical modeling in general, you can send people to http://historicalmodeling.com. This site describes the general concept, common patterns, examples, and the Correspondence reference implementation. The goal of this project is to become a new reference implementation and sandbox for the concept.