27ed0948a1
architecture-guide.md, entities-api.md, entities.md, how-to-contribute.md, getting-started.md, installation.md, roadmap.md, plugin-recipes.md, plugin-system.md, plugins-api.md, project-graphs.md, registry-api.md, settings-api.md, transforms-api.md, transforms.md, understanding-osintbuddy.md, writing-plugins.md, index.md, package.json, icg.svg, AppLayoutSidebar.tsx, Loaders.tsx, index.tsx, LandingPage.tsx, and 2 more files
1.7 KiB
Executable File
title, description
| title | description |
|---|---|
| How to contribute | Contributing to OSINTBuddy development. |
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
- Submitting a fix
- 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.
Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:
- Fork the repo and create your branch from
main. - If you've added code that should be tested, add tests.
- If you've changed APIs, update the documentation.
- Ensure the test suite passes.
- Make sure your code lints.
- Issue that pull request!
Any contributions you make will be under the GNU AGPLv3 Software License
In short, when you submit code changes, your submissions are understood to be under the same GNU AGPLv3 License that covers the project. Feel free to contact the maintainers if that's a concern.
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!
- 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. I'm not even kidding.
License
By contributing, you agree that your contributions will be licensed under its GNU AGPLv3 License.