-
Notifications
You must be signed in to change notification settings - Fork 222
How to Contribute
Amit Patel edited this page Feb 5, 2019
·
31 revisions
Thanks for considering contributing to aima-javascript! We are building visual explanations of the concepts, problems, and solutions described in AIMA.
If you are interested in GSoC then read this guide. The guide for GSoC 2019 will be similar to GSoC 2018. Do not contribute code to the repository! AIMA-Javascript is not like other open source projects so our guidelines are different. Come ask questions on the gitter channel. Amit Patel (redblobgames) was the mentor for GSoC 2017. Sam Goto (samuelgoto) is the mentor for GSoC 2018 and 2019.
If you are not interested in Google Summer of Code, then here's how you can contribute:
- First, read and understand the code to get a feel for how the existing visualizations have been implemented. Read the Implementation guide. Use the existing technology (libraries, languages, frameworks) for the chapter you are working in instead of introducing new technology.
- If you want a small amount of work to get started, look at the issues and pick one to work on. The ones marked “bug” are good starting points. However, due to the nature of this project, there aren't many of these.
- If you want a large amount of work, check the Division of work thread. Pick something that's not already being worked on and post in that thread what you intend to work on. This work will not be useful for GSoC.
- Please squash all commits into a single commit before submitting the pull request.