You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
31 lines
1.5 KiB
31 lines
1.5 KiB
# Contributing Guidelines
|
|
Thank you for considering spending your time contributing to the Splunk 3D Graph Network Topology Visualization. :rocket:
|
|
|
|
Whether you're interested in bug-hunting, documentation, or creating entirely new features, this document will help and guide you through the process.
|
|
|
|
## Issues & Bug Reports
|
|
If you're seeing some unexpected behavior with this project, please create an [issue](https://github.com/splunk/splunk-3D-graph-network-topology-viz/issues) on GitHub selecting the opportune template and providing requested information.
|
|
|
|
## Pull Requests
|
|
We :heart: to see your fixes via pull requests!
|
|
|
|
To create a pull request:
|
|
* [Fork](https://guides.github.com/activities/forking/) the project
|
|
* Create a branch for the issue
|
|
* Make your changes on your branch
|
|
* Thoroughly test your changes
|
|
* Open a [pull request](https://github.com/splunk/splunk-3D-graph-network-topology-viz/pulls)
|
|
|
|
Remember:
|
|
* **Address an issue per branch**
|
|
|
|
## Semi-Automated Release
|
|
A [GitHub Action](https://github.com/splunk/splunk-3D-graph-network-topology-viz/actions/workflows/manual-release.yml) is provided to:
|
|
* Bump the app version
|
|
* Create a release
|
|
|
|
This action can be **manually triggered** by clicking on _Actions / Manual Release / Run Workflow_ and by providing:
|
|
* **Bump part** - Either major, minor or patch
|
|
* (Optional) **Changelog notes** - By default all commit messages beginning from the last release are included
|
|
|
|
> **NOTE** Action available to all users with `Write` role at least |