JakeHillion/storj
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: add contributing guide for SNO development

Browse Source 
Change-Id: I85d84ce9dcf975287b30900e4b895cf7e1461530
This commit is contained in:
Clement Sam 2021-08-26 13:42:27 +00:00
parent b97479e36b
commit 0e1c3cb811
1 changed files with 64 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
docs/storagenode/CONTRIBUTING.md Normal file
View File

@ -0,0 +1,64 @@
# Contribute to the Storage Node development
[legal]: https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license
[license]: https://github.com/storj/storj/tree/main/LICENSE
Hi! Thanks for your interest in contributing to the Storj Network!
Contributions to this project are released under the [AGPLv3 License][license].
For code released under the AGPLv3, we request that contributors sign our
[Contributor License Agreement (CLA)](https://docs.google.com/forms/d/e/1FAIpQLSdVzD5W8rx-J_jLaPuG31nbOzS8yhNIIu4yHvzonji6NeZ4ig/viewform) so that we can re-license the
code under Apache v2, or other licenses in the future.
## Topics
* [Reporting Security Issues](#reporting-security-issues)
* [Quick Contribution Tips and Guidelines](#quick-contribution-tips-and-guidelines)
* [Storage Node Code Walkthrough](#storage-node-code-walkthrough)
* [Testing](#testing)
## Reporting security issues
If you believe you've found a security vulnerability, please send your report to security-reports@storj.io.
We greatly value security, and we may publicly thank you for your report, although we keep your name confidential if you request it.
## Quick contribution tips and guidelines
### Pull requests are always welcome
To encourage active collaboration, pull requests are strongly encouraged, not just bug reports.
We accept pull requests for bug fixes and features where we've discussed the approach in an issue and given the go-ahead for a community member to work on it.
"Bug reports" may also be sent in the form of a pull request containing a failing test. We'd also love to hear about ideas for new features as issues.
Please do:
* Check existing issues to verify that the bug or feature request has not already been submitted.
* Open an issue if things aren't working as expected.
* Open an issue to propose a significant change.
* open an issue to propose a feature
* Open a pull request to fix a bug.
* Open a pull request for an issue with the [`SNO`](https://github.com/storj/storj/labels/SNO) and [`Help Wanted`](https://github.com/storj/storj/labels/Help%20Wanted) or [`Good first issue`](https://github.com/storj/storj/labels/Good%20First%20Issue) label and leave a comment claiming it.
Please avoid:
* Opening pull requests for issues marked `Need Design`, `Need Investigation`, `Waiting For Feedback` or `Blocked`.
* opening pull requests that are not related to any open issue unless they are bug reports in the form pull requests containing failing tests.
Please note that this project adheres to a [Contributor Code of Conduct](https://github.com/storj/storj/tree/main/CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
### Commit Messages
Our guide on good commits can be found at https://github.com/storj/storj/wiki/Git.
## Testing
- See our guide for writing tests here:
- [Testing](https://github.com/storj/storj/wiki/Testing)
- You can spin up a local instance of the V3 Network components (Uplink, Satellite, Storage Nodes), see:
- [Learn how to run the storj-sim test network](https://github.com/storj/storj/wiki/Test-network)
## Resources
- [Storj Whitepaper v3](https://storj.io/whitepaper)
- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)