Skip to content

Commit f1bb703

Browse files
committed
Add list of coding conventions, use link for team members.
1 parent c9509df commit f1bb703

File tree

1 file changed

+20
-9
lines changed

1 file changed

+20
-9
lines changed

CONTRIBUTING.md

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,13 @@ This is the contribute.md of our project. Great to have you here. Here are a few
55

66
## Team members
77

8-
* [Brad Miller](https://github.com/bnmnetp) -- Current maintainer
9-
* [Scott Rixner](https://github.com/rixner)
10-
* [Marie Chatfield](https://github.com/mchat)
11-
* [Albert-Jan Nijburg](https://github.com/albertjan)
12-
* [Bob LaCatena](https://github.com/blacatena)
13-
* [David Holmes](https://github.com/david-geo-holmes)
14-
* [Charles Severance](https://github.com/csev)
15-
* [Scott Graham](https://github.com/sgraham) -- although not active at the moment, Scott is the father of Skulpt
16-
8+
The list of people who have contributed to Skulpt is too big and dynamic to be accurate
9+
in a document like this. Luckily Github does an excellent job of keeping track of
10+
[people who have contributed](https://github.com/skulpt/skulpt/graphs/contributors)
1711

12+
[Brad Miller](https://github.com/bnmnetp) is the current owner of the project. But see below for
13+
the full list of people with commit privileges.
14+
1815
## Learn & listen
1916

2017
This section includes ways to get started with your open source project. Include links to documentation and to different communication channels:
@@ -63,6 +60,20 @@ We try to get to pull requests in a very timely way so they don't languish. Noth
6360

6461
## Coding Style and Conventions
6562

63+
Here are some coding conventions to keep in mind:
64+
65+
* ``Sk.ffi.remapToJs`` and ``Sk.ffi.remapToPy`` are your friends. They take care of the details
66+
of going from a Python type to a Javascript type and vice versa. They are smart enough to work
67+
with common types and even work well recursively converting containers. ``Sk.ffi.remapToJs`` is
68+
**definitely preferred** over ``foo.v``
69+
* Use the ``pyCheckArgs`` function at the beginning of anything that will be exposed to a Python programmer.
70+
* Check the types of arguments when you know what they must be.
71+
* Explicitly return ``Sk.builtin.null.null$`` for functions and methds that should return ``None``
72+
* If you are adding a module or package to the library, respect the package/module conventions.
73+
* modules should be named ``foo.js`` or ``foo.py``
74+
* packages should be a directory with an ``__init__.js`` or ``__init__.py`` file, and possibly additional modules.
75+
76+
6677
In summer of 2014, we adopted the following style and conventions for our code:
6778

6879
* Braces: One True Brace style -- that means open braces go on the same line as the

0 commit comments

Comments
 (0)