👍🎉 Thanks so much for taking the time to contribute! 🎉👍
The following is a set of guidelines for contributing to Sema and its engine, the sema-engine, which are hosted here on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
I don't want to read this whole thing, I just have a question!!!
What should I know before I get started?
- Reporting Bugs
- Suggesting Enhancements
- Your First Code Contribution
- Pull Requests
- Styleguides
- Git Commit Messages
This project and everyone participating in it is governed by the Sema Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].
Note: Please don't file an issue to ask a question. You'll get faster results by using the resources below. Reach out on our community Discord channel if you are stuck.
Sema consists of two main packages, sema and the sema-engine. The sema repo deals with everything you see on the front end side of things and works as an interface between the engine and the many other components such as the backend. The engine on the other hand is what deals with running the core components of sema under the hood. Language compilation, language creation, sound generation and running code from the javascript editor.
It also relies on many other open source projects. To list some of the main ones we use
- Svelte for everything on the frontend.
- Routify for routing on the site.
- Supabase for the backend.
- Nearley for language creation.
- Maximillian for all things sound.
Sema is quite a big project with many components and areas. If you feel intimidated the best thing to do is look at specific cases/areas of how things have been done already and try copy and build from them. For example, you want to build a widget? Look at how a fairly simple widget such as the liveCodeParserOutput is implemented, consumes output from the engine and displays it as a svelte component. The internal sema documentation as well as the github wiki are also valuable resources if you want to learn more.
This section guides you through submitting a bug report for Sema. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behavior 💻 💻, and find related reports 🔎.
Before creating bug reports, please check this list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible.
Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
-
Check the debugging guide. You might be able to find the cause of the problem and fix things yourself. Most importantly, check if you can reproduce the problem in the latest version of Sema. This will always be on the develop branch.
-
Perform a cursory search to see if the problem has already been reported. If it has and the issue is still open, add a comment to the existing issue instead of opening a new one.
Bugs are tracked as GitHub issues. After you've determined which repository your bug is related to, create an issue on the repository and provide the following information by filling in the template below:
Expected behavior:
Actual behavior:
Reproduces how often:
Explain the problem and include additional details to help maintainers reproduce the problem:
- Use a clear and descriptive title for the issue to identify the problem.
- Describe the exact steps which reproduce the problem in as many details as possible. For example, start by explaining how you started Sema, e.g. which command exactly you used in the playground or tutorial. When listing steps, don't just say what you did, but explain how you did it. For example, if you moved the cursor to the end of a line, explain if you used the mouse, or a keyboard shortcut or an Sema command, and if so which one?
- Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use Markdown code blocks.
- Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
- Explain which behavior you expected to see instead and why.
- Include screenshots and animated GIFs which show you following the described steps and clearly demonstrate the problem. You can use this tool to record GIFs on macOS and Windows, and this tool or this tool on Linux.
- If the problem wasn't triggered by a specific action, describe what you were doing before the problem happened and share more information using the guidelines below.
Provide more context by answering these questions:
- Did the problem start happening recently (e.g. after updating to a new version of Sema) or was this always a problem?
- Can you reliably reproduce the issue? If not, provide details about how often the problem happens and under which conditions it normally happens.
Include details about your configuration and environment:
- Which browser and what version are you using? You can get the exact version by by checking the About section on the application menu .
- What's the name and version of the OS you're using?
- What's the name and version of node/npm you're using?
This section guides you through submitting an enhancement suggestion for Sema, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion 📝 and find related suggestions 🔎.
Before creating enhancement suggestions, please check this list as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please include as many details as possible, including the steps that you imagine you would take if the feature you're requesting existed.
- Check the debugging guide for tips — you might discover that the enhancement is already available.
- Determine which labels the enhancement should be suggested with.
- Perform a cursory search to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
Enhancement suggestions are tracked as GitHub issues. After you've determined which part of Sema your enhancement suggestion is related to, create an issue on that repository and provide the following information:
- Use a clear and descriptive title for the issue to identify the suggestion.
- Provide a step-by-step description of the suggested enhancement in as many details as possible.
- Provide specific examples to demonstrate the steps. Include copy/pasteable snippets which you use in those examples, as Markdown code blocks.
- Describe the current behavior and explain which behavior you expected to see instead and why.
- Include screenshots and animated GIFs which help you demonstrate the steps or point out the part of Sema which the suggestion is related to. You can use this tool to record GIFs on macOS and Windows, and this tool or this tool on Linux.
- Explain why this enhancement would be useful to most Sema users and isn't something that can or should be implemented.
- List some other similar websites or applications where this enhancement exists.
Browse the issues and look for labels with good first issue or help wanted. These are a good place to start if you want to contribute but stuck with what to do.
When making pull requests to the repository, make sure to follow these guidelines for both bug fixes and new features:
- Before creating a pull request, file a GitHub Issue so that maintainers and the community can discuss the problem and potential solutions before you spend time on an implementation.
- In your PR's description, link to any related issues or pull requests to give reviewers the full context of your change.
- Make sure you commit messages are highly descriptive of the change you are making.
Check out our design guide wiki page on our design choices and style guides for within sema itself.
- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
- Limit the first line to 72 characters or less
- Reference issues and pull requests liberally after the first line
- Consider starting the commit message with an applicable emoji:
- 🎨
:art:when improving the format/structure of the code - 🐎
:racehorse:when improving performance - 🚱
:non-potable_water:when plugging memory leaks - 📝
:memo:when writing docs - 🐧
:penguin:when fixing something on Linux - 🍎
:apple:when fixing something on macOS - 🏁
:checkered_flag:when fixing something on Windows - 🐛
:bug:when fixing a bug - 🔥
:fire:when removing code or files - ✅
:white_check_mark:when adding tests - 🔒
:lock:when dealing with security - ⬆️
:arrow_up:when upgrading dependencies - ⬇️
:arrow_down:when downgrading dependencies - 👕
:shirt:when removing linter warnings
- 🎨