vantage6
CHECK OUT OUR NEW DOCUMENTATION
3 | Petronas
3 | Petronas
  • Welcome
  • Background
    • Architecture
    • Partners
    • Release notes
    • How to contribute
  • Install
    • Requirements
      • 🐍Python
      • 🐳Docker
    • Client
    • Node
    • Server
      • User Interface
      • EduVPN
      • RabbitMQ
      • Docker registry
  • Use
    • Preliminaries
    • Client
      • User Interface
      • Python client
        • Authentication
        • Creating an organization
        • Creating a collaboration
        • Registering a node
        • Creating a task
      • R Client
      • Server API
    • Node
      • Configure
      • Security
      • Logging
    • Server
      • Configure
      • Batch import
      • Shell
      • Deployment
      • Logging
  • Algorithms
    • Concepts
      • Input & output
      • Wrappers
      • Mock client
      • Child containers
      • Networking
      • Cross language
      • Package & distribute
    • Tutorial
      • Introduction
    • Classic Tutorial
  • References
    • Glossary
Powered by GitBook

This documentation space is no longer maintained. For the latest documentation please refer to https://docs.vantage6.ai

On this page
  • If you're a developer
  • Fixing issues or adding features
  • Maintenance
  • If you're a tester (and breaker)
  • If you're into security, privacy

Was this helpful?

Edit on GitHub
Export as PDF
  1. Background

How to contribute

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

PreviousRelease notesNextRequirements

Last updated 2 years ago

Was this helpful?

If you're a developer

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

Fixing issues or adding features

Found a security issue?

Please see our 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. Create an on the Github page.

  2. Create a branch starting with /bugfix in the case of a bug, or with /feature in the case of a new feature.

  3. Implement your fix.

  4. Push the branch and open a .

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 up.

  • Maintaining good 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.

  • Feel free to install our development version of vantage6 and try to break it.

If you're a tester (and breaker)

Join our , and get into the Development section.

Issues can be reported on our .

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 .

👨‍🔬
👮
👩‍💻
Discord channel
SECURITY
issue
Pull Request
coverage
code quality
Discord channel
Github page
vantage6@iknl.nl