Thank you for your interest in contributing to Exeme. There are many different ways to contribute, and they are all appreciated. If you have any questions, feel free to ask on the GitHub.
Everyone who contributes to Exeme is expected to:
- Read the Code of Conduct. We expect everyone in our community to be welcoming and friendly.
The core libraries and documentation are the areas that are in most need of input. Any enhancements to parts of the compiler are welcome.
If you add new functionality, or change the way current functionality works, add or edit the docs to reflect this. This is so that users have documentation of the new changes.
Remember to add your name, GitHub profile, and email address to the official Contributors File.
You can easily follow the same coding style and syntax rules by looking at the Exeme source code. It is also recommended to install clang-format, which can format your code using the src/.clang-format file.
licenses are required at the top of all non-trivial files.
Markdown files always have at the top:
<!-- Part of the Exeme Project, under the MIT license. See '/LICENSE' for license information. SPDX-License-Identifier: MIT License. -->For example, see the top of this file's raw contents.
C++ source code files always have at the top:
// Part of the Exeme Project, under the MIT license. See '/LICENSE' for
// license information. SPDX-License-Identifier: MIT License.For example, see the top of src/main.cpp file's contents.
Every file type uses a variation of the above license text (MIT License) with similar formatting.