#265: Added CONTRIBUTING and moved install guide
This commit is contained in:
frikky
@@ -1,15 +0,0 @@
|
||||
**/.git*
|
||||
**/.gitlab-ci.yml
|
||||
**/.env
|
||||
**/.dockerignore
|
||||
**/Dockerfile*
|
||||
**/node_modules
|
||||
buildSrc/libs
|
||||
.gradle/
|
||||
build/
|
||||
**build/
|
||||
.idea/
|
||||
!.idea/codeStyles/codeStyleConfig.xml
|
||||
.DS_Store
|
||||
*.log
|
||||
out/
|
||||
@@ -0,0 +1,39 @@
|
||||
# Contributing to Shuffle
|
||||
|
||||
First off, thank you for contributing to [Shuffle](https://shuffler.io/)! Your talents and your contributions are greatly appreciated. With Shuffle, we aim to make cybersecurity more accessible, and keep that in mind with everything we make.
|
||||
|
||||
## Opening a new issue
|
||||
|
||||
If you find a bug or think of an improvement or fix, please open a [new issue](https://github.com/frikky/Shuffle/issues/new). Outline every step necessary to reproduce the bug. Include screenshots, logs and/or code examples where applicable. The more thorough you are, the better.
|
||||
|
||||
## What you can work on
|
||||
There are a lot of things to work on in our complex ecosystem. The most pressing issues are documentation, use-cases and content-creation, but any help is appreciated. We'll make sure you get the help you need to get started. Below is an incomplete list of items. If you see an issue, tell us or fix it! :)
|
||||
|
||||
#### App Creation (Python & GUI w/OpenAPI)
|
||||
As with everything else, app creation for Shuffle is made as accessibl as possible with the app editor. However, there are some instances where it can't do the job, and you'll have to write Python code. The App Editor generates OpenAPI specifications and can be widely shared, while Python apps only work for Shuffle and NSA's WALKOFF (which Shuffle is based on). You can find our [OpenAPI apps here](https://github.com/frikky/security-openapis) and our [Python apps here](https://github.com/frikky/shuffle-apps). Apps in these repositories are automatically available after installation. Shuffle apps are searchable on [https://shuffler.io](https://shuffler.io/search).
|
||||
|
||||
#### Workflow creation (GUI & Conceptualizing)
|
||||
Workflows are where the magic of Shuffle automation happens. Our current ones [are outlined here](https://github.com/frikky/security-openapis), and will be automatically imported into Shuffle instances in the future. They are split into Prepare and Response, but don't necessarily have to be. If you'd like to talk about workflow creation or use-cases in general, either Open a [new issue](https://github.com/frikky/shuffle-workflows/issues/new) or send us an email at [frikky@shuffler.io](mailto:frikky@shuffler.io)
|
||||
|
||||
#### Documentation (Markdown)
|
||||
Documentation is essential to any product, and Shuffle is no exception. Documentation in Shuffle uses markdown and is located in the [shuffle-docs](https://github.com/frikky/shuffle-docs/tree/master/docs) repository. These are then loaded into Shuffle when someone visits [https://shuffler/docs/about](https://shuffler/docs/about), then cached for later use. If you make an edit, expect it on our website in about an hour.
|
||||
|
||||
#### Frontend (ReactJS)
|
||||
The frontend of Shuffle is what everyone sees when they log in. Our goal here is to make it easy to get started and keep going with Shuffle - removing any blockers from the point of accessibility. If you'd like to get started, find [an issue](https://github.com/frikky/Shuffle/issues) and check the [installation guide](https://github.com/frikky/Shuffle/blob/master/install-guide.md#local-development-installation) for setting it up locally without Docker.
|
||||
|
||||
#### Backend (Golang)
|
||||
The backend of Shuffle is our REST API Server that runs in the background, handling all the API-calls in general, whether from users or apps. If you'd like to get started, find [an issue](https://github.com/frikky/Shuffle/issues) and check the [installation guide](https://github.com/frikky/Shuffle/blob/master/install-guide.md#local-development-installation) for setting it up locally without Docker.
|
||||
|
||||
## Working on an issue
|
||||
|
||||
**Shuffle** uses the [GitHub flow](https://guides.github.com/introduction/flow/index.html). All project changes are made through pull requests.
|
||||
If you see an issue that you would like to work on, leave a quick comment or just get cracking.
|
||||
|
||||
### License
|
||||
|
||||
All contributions are made under either the **GNU Affero General Public License v3.0** or **MIT** license. See below for further details.
|
||||
|
||||
* [Main project license - AGPLv3](https://github.com/frikky/Shuffle/blob/master/LICENSE)
|
||||
* [Apps - MIT](https://github.com/frikky/Shuffle-apps/blob/master/LICENSE)
|
||||
* [Workflows - MIT](https://github.com/frikky/Shuffle-workflows/blob/master/LICENSE)
|
||||
* [Documentation - MIT](https://github.com/frikky/Shuffle-docs/blob/master/LICENSE)
|
||||
@@ -1,17 +0,0 @@
|
||||
## Contributing to Shuffle
|
||||
|
||||
First off, thank you for contributing to [Shuffle](https://shuffler.io/)! Your talents and your contributions are greatly appreciated.
|
||||
|
||||
### Opening a new issue
|
||||
|
||||
If you find a bug or think of an improvement or fix, please open a [new issue](https://github.com/frikky/Shuffle/issues/new). Outline every step necessary to reproduce the bug. Include screenshots and code examples where applicable. The more thorough you are, the better.
|
||||
|
||||
### Working on an issue
|
||||
|
||||
**Shuffle** uses the [GitHub flow](https://guides.github.com/introduction/flow/index.html). All project changes are made through pull requests.
|
||||
|
||||
If you see an issue that you would like to work on, be sure to leave a quick comment asking if the issue is free to be worked on.
|
||||
|
||||
### License
|
||||
|
||||
All contributions are made under the **GNU Affero General Public License v3.0**. [See the license page](https://github.com/frikky/Shuffle/blob/master/LICENSE) for further details.
|
||||
@@ -6,7 +6,7 @@
|
||||
|
||||
|
||||
## Try it
|
||||
* Self-hosted: Check out the [installation guide](https://github.com/frikky/shuffle/blob/master/install-guide.md)
|
||||
* Self-hosted: Check out the [installation guide](https://github.com/frikky/shuffle/blob/master/.github/install-guide.md)
|
||||
* Cloud: Register at https://shuffler.io/register and get cooking (missing a lot of features)
|
||||
|
||||
Please consider [sponsoring](https://github.com/sponsors/frikky) the project if you want to see more rapid development.
|
||||
@@ -43,7 +43,20 @@ Please consider [sponsoring](https://github.com/sponsors/frikky) the project if
|
||||
|
||||
|
||||
## Website
|
||||
https://shuffler.io
|
||||
[https://shuffler.io](https://shuffler.io)
|
||||
|
||||
## Contributing
|
||||
We want to make the world of cybersecurity more accessible and need all the help we can get. Send an email to [frikky@shuffler](mailto:frikky@shuffler.io) and we'll make sure to give you any training you may need.
|
||||
|
||||
These are the main areas to contribute in:
|
||||
* Frontend (ReactJS)
|
||||
* Backend (Golang)
|
||||
* App Creation (Python & GUI w/OpenAPI)
|
||||
* Documentation (Markdown)
|
||||
* Workflow creation (GUI & Conceptualizing)
|
||||
* Content Creation (Blogs, videos etc)
|
||||
|
||||
Contributing guidelines for Github are outlined [here](https://github.com/frikky/Shuffle/blob/master/.github/CONTRIBUTING.md).
|
||||
|
||||
## Contributors
|
||||
|
||||
@@ -61,8 +74,10 @@ https://shuffler.io
|
||||
## License
|
||||
All modular information related to Shuffle will be under MIT (anyone can use it for whatever purpose), with Shuffle itself using AGPLv3.
|
||||
|
||||
Apps & App SDK: MIT
|
||||
Workflows: MIT
|
||||
Documentation: MIT
|
||||
Shuffle backend: AGPLv3
|
||||
Apps, specification and App SDK: MIT
|
||||
|
||||
### Repository overview
|
||||
Below is the folder structure with a short explanation
|
||||
|
||||
Reference in New Issue
Block a user