First off, thanks for taking the time to contribute! ❤️
All types of contributions are encouraged and valued. See the Table of Contents for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉
Please read (or at least scan) the specification before asking a question.
Before you ask a question, it is best to search for existing Issues that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue.
If you then still feel the need to ask a question and need clarification, we recommend the following:
- Open an Issue.
- Provide as much context as you can about what you're running into.
- Provide project and platform versions, depending on what seems relevant.
We will then take care of the issue as soon as possible.
When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.
Please complete the following steps in advance to help us fix any potential bug as fast as possible.
- Make sure that you are using the latest version.
- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions. If you are looking for support, you might want to check section “I have a question”.
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the bug tracker.
- Collect information about the bug:
- Stack trace (Traceback)
- OS, Platform and Version of both Triton VM and
rustc - Possibly your input and the output
- Can you reliably reproduce the issue, or does it happen only occasionally?
You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead, sensitive bugs must be sent by email to ferdinand@neptune.cash.
Please use this PGP key to encrypt sensitive information.
-----BEGIN PGP PUBLIC KEY BLOCK-----mQGNBGJGy8oBDADTHQh51Qwz5urObIhJ/SXmzpFQx5ERd6kuAqyC9LaW8XeObDjx I1DB3LrK25Gusj5+nl+BjZCN+Vj6Okp8YFAirDV6+yJSnmhyvX2UX+luhTR7qKlW Q9Kz+QZaDbulcDLRt3iw+ENE0tIiU3+GrS8FNkrpj761z0Kkn2qTLenRlA4heZyC tomvkBa3qY7lw02ar3R5WMxTXTLapXvVzUpjYqhSxp2qZQp6tjWUVRfCLHdl3W5W AXP2BKvPak17k07Efe/K8TtXRPgpEnyGdGOAejp76hkkg2W29MwbJgtKlBgajA+C lNUhu2OWRpw1UiwinJKqQpjVFryFemSjQlRMppgM5SMZhE2flT0OJfU8cbZPYXbx JAlWSQsm6MV4N0lCNJ5UAbFosPI1jWu+7ac215qx/EtwXoBLqhsXbwI+50XVbZrS S/kFSIuOqz5ESlpAm/oS+N0KyIPfsS6X23Zoi3H6C6pKFtC6xjo6zFYQtFTwE+Eq t+SAnNxdjmqnl9UAEQEAAbQsSmFuIEZlcmRpbmFuZCBTYXVlciA8ZmVyZGluYW5k QG5lcHR1bmUuY2FzaD6JAdQEEwEKAD4CGwMFCwkIBwIGFQoJCAsCBBYCAwECHgEC F4AWIQTJrPdjU22yUYotbUoEaKjx4pCXWQUCZglNtwUJCWYcbQAKCRAEaKjx4pCX WbiwC/4/lxzUhWhfUVOJtIbb5X12dINt5pudTelHIGlnsNRVvVjDeQBkPw9pE3X/ YB8/8TfWKhl4ygvxwHrr+iATnfeSKnnDo0gyetz95i3+EMJApBCTm8iZatiokNhe tqjaDdqC4dbwFfWIhym0uoj7KdAlaTLLC84FQdrRj+ZY41spoD7s6BCXjIzFcOQz MT05fmRaN/mu4h0dNRtwDxzSvSxVS2lor3wpIek23Qsx6jeAx/GGIwM7S0Cfr2pX HxYD8tJK/2inyABkwSvw1fW22HTndnDx3gL/mElORO/N+mCUWHszY6U88ZG0Lgtn 942GSrQ8ZDpP6YjGq2cqYn23FK/zfgSGy94+arTaMVS6aD/2GHFOe+XjL9fTjk84 3RCw5FehG9QetXI7qStj4tOKuqa1EkedUFB5tcPkHQAldbEqtvjH31wWYiKoSXsB 35V5WJF5z+3tuiuj+aW+f6Z7LXbt8xiXovvSMPGFZ8nCNrVuuU/sXDj2AAZgqua7 Dkg/MoG5AY0EYkbLygEMAKSxNPmkaSfiQSd3Aau4bosozkD4Olc0eBlToRyQYQGv 91CEx+H7Bxkrwgvxn7rwc3AzNGzzhpKd04hH96qEqcXqhUbemkYE0laENEFf1mib 2QjgDsSGSVoRHr3TyJ7FMQyw0v/BAtI0LkzbDY+SrMDlywpfFLvYaGSDR5blhzC5 he6qYS3ctY3K0bnTSF+KhRbPhvI3OUtqwxB2iqR21mhXAu2Ad3IV0qxdxF3TJ/W2 F75bLoE+CzX+h9K9UBScMWtckenWrqMHpQ1LQ/0yJrww7w4rsTEavu+DLS+MZFOi fCDRFIohSmgOUZQ0CuwfQVnyWVRTQwxRE8MXREoUvYrXfvi9sNyk+UW2VGq98Dj5 da6mxstP4Lc+0L6G3XlF3jhhES0uYE+K/qeWXyWRjR2sFLbNMi0w15Yo5O0MCMym CsOoGiYowqArnEo1nOOBBLn9aJjYxQrLFKiU3QycpADo0LvwxokjpupbigZ5J7br tgouAu05yjHRP4f5z5yYiwARAQABiQG8BBgBCgAmAhsMFiEEyaz3Y1NtslGKLW1K BGio8eKQl1kFAmYJTcMFCQlmHHkACgkQBGio8eKQl1kkUgwAgBd2rGPz2C5HkGN/ xlGlJ0soczef0N7yIRdTlKZdsS6Q6QxYGaNgfnN5ars6rOl20daqzdkFCUZjR7ym ldxtUbGuUwkKZGFayhVJ1+NKJEHloc0Ga+5SsJOnbqL8WH6m7yToB7NOlPTY01EE N2UjMrQDewPTXaj0PCHrjy6TCt5WdD/ATefbs2k9hdpWb5UU30WXYoU/iSxvE8X5 FZekN8koUQTIoCtEoatZHo/cks9Ydm7Ef4nKNLTOgc5p9ioTy4VFd4up6qPDSQG4 +Xvmh+NqbCMB4RqGB22P8Iv3swLVRRTaO+2zj4MRCqyjgjSvy7nMASneOTBQNWAe HoskJlPbIMACeMXsnd4jXhSqOh/iXGHsu+w/tazS7SkgVtuLIlOLlP6yatiBHpQj UDYwLHEas3AAFA76j6HO6NAsyu6FKPVji3uyUEPwvJl/BcA4h+C4LoQVucs5+g09 4TSKGFYMRIk160B0i7kTWmp6/t8QOBCarnSzpCy6PunzduXO =8K5o -----END PGP PUBLIC KEY BLOCK-----
We use GitHub issues to track bugs and errors. If you run into an issue with the project:
- Open an Issue.
- Explain the behavior you would expect and the actual behavior.
- Please provide as much context as possible and describe the reproduction steps that someone else can follow to recreate the issue on their own. This usually includes your code. For an excellent bug report, create a reduced test case.
- Provide the information you collected in the previous section.
Once it's filed:
- The project team will label the issue accordingly.
- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps. A bug will only be addressed once it can be reproduced.
- If the team is able to reproduce the issue, the issue will be left to be implemented by someone.
This section guides you through submitting an enhancement suggestion for Triton VM, including completely new features and minor improvements to existing functionality. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
- Make sure that you are using the latest version.
- Read the documentation carefully and find out if the functionality is already covered, maybe by an individual configuration.
- Perform a 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.
- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset.
Enhancement suggestions are tracked as GitHub issues.
- 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.
- Describe the current behavior and explain which behavior you expected to see instead and why. At this point you can also tell which alternatives do not work for you.
- Explain why this enhancement would be useful to most Triton VM users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
Triton VM uses a pretty standard cargo setup.
Verify that cargo test runs successfully, then dive in.
If you don't already know where you want to start, you might find the examples helpful.
Documentation can always be better, and getting into a new project often reveals documentation gaps other developers have gotten blind to. We welcome documentation updates and upgrades.
Contributions that are of very low effort will either be incorporated without attributing the contributor or ignored outright. For example, we consider fixing the spelling of a single word in some documentation file as “low effort.”
The reason for this stance is the following: Sometimes, cryptocurrencies chose to award some of their tokens to contributors of their ecosystem, of which Triton VM is sometimes a part. Usually, contributor identification is automated in some fashion, and no regard is given to contribution quality. (How would you even quantify the quality?) This fact is used by some people to try to stake a claim at such potential future rewards by getting their name into the contributors list. We think this is unethical, and therefore, we reject low-effort contributions, or incorporate them in a way that is difficult to automatically link to the original author.
Please do not take above explanation as any form of guarantee that meaningfully contributing to Triton VM will grant you such rewards. It might be the case, but is both out of our hands and a poor motivator for working on Triton VM.
Triton VM uses an import granularity of item and a group order strategy of StdExternalCrate in order to trivialize git merging of imports.
Unfortunately, both of these cargo_fmt features are unstable for now and thus require manual editing or a formatting pass with nightly rust.
Other than that, Triton VM has no formal style requirements at the moment. However, the core contributors might impose their (informal) style requirements on your pull request. 😊
Triton VM uses conventional commits. We have a list of established commit types. If you're missing a commit type, you can introduce it by adding to the list.
In addition to being conventional, commit messages for Triton VM follow this guide. Summarizing:
- Separate subject from body with a blank line
- Limit the subject line to 50 characters
- Capitalize the subject line
- Do not end the subject line with a period
- Use the imperative mood in the subject line
- Wrap the body at 72 characters
- Use the body to explain what and why vs. how
This guide is based on the contributing.md.