Skip to content

Latest commit

 

History

History
59 lines (30 loc) · 4.94 KB

CONTRIBUTING.md

File metadata and controls

59 lines (30 loc) · 4.94 KB
Raw

Contributing to OpenBAS

Thank you for reading this documentation and considering making your contribution to the project. Any contribution which help us improve the platform is valuable and much appreciated. If it is also meaningful to you or your organisation it’s all for the best.

In order to help you understand the project, where we are heading and how you can contribute, below are several resources and answers.

Do not hesitate to shoot us an email or join us on our Slack channel. Most of the articles below are an introduction for our detailed documentation.

Why contribute?

OpenBAS is an open source project aiming at building a platform for threat intelligence analysts, allowing them to capitalise, structure, organise and visualise amouts of information. It allows analysts to leverage knowlegde from these information while keeping track of each and every source of information (if you want to know more about OpenBAS, you can read the detailed documentation or try it on the demonstration plateform).

Whether you are an organisation or an individual working or studying in the field of cybersecurity and cyberdefense, or simply as an individual looking for a technical challenge, contributing to the OpenBAS project may represent a great opportunity for you.

  • You can help grow the community and a tool focused on improving the understanding of cyberthreats and therefore enhancing our capability of better protecting our organisations and societies ;

  • You will be able to adapt the tool to your core interests and methods of work by developping features or fixing bugs you are most interested in ;

  • OpenBAS is also an interesting opportunity for developpers to work on new technologies such as React/REST technologies.

Where is the project heading ?

Now that the first version of the tool has been released, our goal for the future releases is two-fold :

  • Of course, fix bugs and develop features which are identify as non-critical but would really add-up to OpenBAS power ;

  • On a longer term vision, we would like to develop a multi-layered approch in the platorm, which would be divided in three strata : a strategic level (for informations about actors), a kill chain level (with the different steps of the attack chain) and an infrastructure level (containing data on the infrastructure used by the attacker).

Code of Conduct

OpenBAS has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand which actions will and will not be tolerated.

How can you contribute ?

Any contribution is appreciated and many don’t imply coding. Contributions can range from a suggestion for improving documentation, requesting a new feature, reporting a bug, to developping features or fixing bugs yourself.

For general suggestions or questions about the project or the documentation, you can open an issue on the repository with the label "question". We will answer as soon as possible. If you do not wish to publish on the repository, please see the section below "How can you get in touch for other questions?".

  • Just using OpenBAS and opening issues if everything is not working as expect will be a huge step forward. See our section about opening an issue. To report a bug, please refer to the bug reporting module. To suggest a new feature, please fill in the feature request form.

  • Don’t hesitate to flag us an issue with the documentation or the templates if you find them incomplete or not clear enough. You can do that either by opening a bug report or by sending us a message on our Slack channel.

  • You can look through opened issues and help triage them (ask for more information, suggest workarounds, suggest label, flag issues etc.)

  • If you are interested in contributing to developping OpenBAS, please refer to the detailed documentation. It can be either a to fix an issue which is meaningful to you, or to develop a feature requested by others.

  • All commits messages must be formatted as: [component] Message (#issuenumber) where component should be:

    • api
    • frontend
    • worker
    • doc

How can you get in touch for other questions ?

If you need support or you wish to engage a discussion about the OpenBAS platform, feel free to join us on our Slack channel. You can also send us an email.