Skip to content

Contribute

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Proposing new features
  • Becoming a maintainer

We Develop with Github

We use github to host code, to track issues and feature requests, as well as accept pull requests.
We Use Github Flow, So All Code Changes Happen Through Pull Requests Pull requests are the best way to propose changes to the codebase (we use Github Flow). We actively welcome your pull requests:

  1. Fork the repo and create your branch from master.
  2. If you've added code that should be tested, add tests.
  3. Ensure the test suite passes.
  4. Make sure your code lints.
  5. Issue that pull request!

Report bugs using Github's issues

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
  • Be specific!
  • Give sample code snapshots if you can.
  • What you expected would happen
  • What actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

People love thorough bug reports.

Processes expected to follow by each contributors:

Use a Consistent Coding Style

You must follow the coding standard described in the Be-Secure review Checklist.

Developers View

Please refer to the following link to know more about BeSman. It is built using bash and can be easily customized to provision new environments for an open source tech stack based on open source project requirements. Anyone can leverage BeSman utility to build customized environments for their projects.  

You can set up BeSman utility by following the steps mentioned in the Readme file.  

You can raise an issue once you encounter any issue with using available Besman environment scripts or using BeSman utility, we will be glad to help address the issue for you.  

If you are interested in resolving identified issues with the known list of BeSman environments or BeSman utility, you can raise a pull request with the required fixes. We value your contributions.

License

Be-Secure Project is Apache 2.0 licensed. In short, when you submit code changes, your submissions are understood to be under the same Apache License 2.0 that covers the project. Feel free to contact the maintainers if that is a concern.

By contributing, please ensure that you accept the Developer’s Certificate Origin that will be available as part of your pull request.

FAQs

Click here for FAQs

Back to top