Development and Community
SML# development team
The development of SML# is being steered by SML# development team. The current members of SML# development team are the following (in alphabetical order):
- Atsushi Ohori (RIEC, Tohoku University)
- Katsuhiro Ueno (Niigata University)
Community
The following are places for developers and users to have open-ended discussion about SML#. GitHub account is needed to join the discussion.
- smlsharp/forum/discussions (English)
- smlsharp/forum_ja/discussions (Japanese)
The official Twitter account of SML# is @smlsharp. This account tweets on SML# such as new releases. We encourage all SML# users to follow this account. Please send DM or mention to this account if you would like to contact SML# development team directly.
Repository guide
The source code of SML# is managed by git, a version control system. The source code of bleeding edge is in the repositories on GitHub. To obtain the latest source code, run the following command:
git clone https://github.com/smlsharp/smlsharp.git
Not only source code but also relevant resources such as documents and webpages are maintained on GitHub. The following is the list of repositories that SML# development team manages:
- smlsharp/smlsharp: The SML# compiler and tools
- smlsharp/smlsharp-document: SML# document
- smlsharp/smlsharp-package: scripts for building release packages
- smlsharp/homebrew-smlsharp: Homebrew formula
- smlsharp/repos: Package pepositories of binary packages
- smlsharp/smlsharp.github.io: The source of this website
- smlsharp/forum, smlsharp/forum_ja: forums
smlsharp/smlsharp is the primary source and bleeding edge of the compiler, tools, and libraries developed by SML# project.
Reporting issues
If you find bugs or mistakes in the SML# project’s code or documentation, please let us know by submitting an issue ticket on GitHub Issues. Please make sure that you choose the appropriate repository to report issues (for example, issues on the SML# compiler must be reported to smlsharp/smlsharp, and issues on the document must be reported to smlsharp/smlsharp-document).
If you wonder whether what you find is an issue or not, please ask us on the forum before submitting it as an issue.
Cotributing code
We always welcome contributions from the community. Please let us know your contribution by a pull request on GitHub. SML# development team reviews the request and decides its acceptance. Before sending a pull request, please agree on the following:
- When your pull request is merged, The license of SML# is applied to everything you send. This means that your effort is donated to the SML# project.
For very small and/or streightforward changes and improvements, such as fixing typos, you can send pull requests without any prior discussion. If you have some questions, or the changes are relatively large, please discuss on the forum or issue tracking system before sending pull requests.
Correlated repositories
The following repositories has been forked from the SML# project and being maintained by the community.
These three repositories are related to the SML# development team, but not maintained by the SML# development team. Consult these repositories for how to report issues and contribute code.