vantage6
3 | Petronas
Search…
⌃K
Links

How to contribute

Developing new features, fixing known issues, adding documentation, adding new tests, or reporting issues

👩💻
If you're a developer

Join our Discord channel, and get in touch with the infrastructure developers.

Fixing issues or adding features

Found a security issue?
Please see our SECURITY policy.
Whenever you found an issue and wrote a fix or when you just want to help improving the code, where happy that you want to contribute to the code base. The process to submit a fix would be as follows:
  1. 1.
    Create an issue on the Github page.
  2. 2.
    Create a branch starting with /bugfix in the case of a bug, or with /feature in the case of a new feature.
  3. 3.
    Implement your fix.
  4. 4.
    Push the branch and open a Pull Request.
Then it is out of your hands for now. A reviewer will look at the issue and code and will request changes if needed. Once the code is finalized it will be released as soon as possible (depening on the implications this could be released as a patch version).

Maintenance

  • A great way to learn about the source is writing unit-tests to test existing components. This helps us getting our coverage up.
  • Maintaining good code quality is important, so do some housekeeping, refactoring and cleaning really helps us writing good code.
  • Writing documentation, both in the code and on this Documentation page.

👨🔬
If you're a tester (and breaker)

  • Join our Discord channel, and get into the Development section.
  • Feel free to install our development version of vantage6 and try to break it.
  • Issues can be reported on our Github page.

👮
If you're into security, privacy

One of the top priorities of vantage6 is being secure in what it does. Therefore having people reporting possible security issues to us is immensely helpful. If you have security concerns please report them directly to [email protected].