Add important community documentation #6
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
erbesharat
requested changes
Oct 25, 2024
There was a problem hiding this comment.
Overall looks great, if you think the stuff I mentioned are not needed atm, just ignore the change request and merge.
- I think it would be good to have
USERS.mdfile listing our "early adapters" and link to the list on README to honor them. Example: https://github.com/txtdirect/txtdirect/blob/master/USERS.md - Maybe a
SUPPORT.mdas well which includes detailed info for non-techy people as well. not so similar example: https://github.com/txtdirect/txtdirect/blob/master/SUPPORT.md - Since this tool belongs to the company and not a person, it's better to have CLA files for both individuals and also corporates.
Individual example: https://github.com/txtdirect/txtdirect/blob/master/CLA/INDIVIDUAL_CONTRIBUTOR_LICENSE_AGREEMENT.md
Corpo: https://github.com/txtdirect/txtdirect/blob/master/CLA/CORPORATE_CONTRIBUTOR_LICENSE_AGREEMENT.md - List our logos and any other artwork for the tool under a media/ dir for people to use when they're creating content about us!
Example: https://github.com/txtdirect/txtdirect/blob/master/media/logo.svg
| @@ -0,0 +1,3 @@ | |||
| # Security Policy | |||
|
|
|||
| If you discover a security issue in this project, or have any concerns, please report them to [security@nanoapi.io](mailto:security@nanoapi.io). All security vulnerabilities will be promptly addressed within 72 hours. No newline at end of file | |||
There was a problem hiding this comment.
What do you think about a more detailed version which also mentions our "hosted" version for future.
Suggested change
| If you discover a security issue in this project, or have any concerns, please report them to [security@nanoapi.io](mailto:security@nanoapi.io). All security vulnerabilities will be promptly addressed within 72 hours. | |
| Please report any suspected security vulnerabilities privately to [security@nanoapi.io](mailto:security@nanoapi.io). Please do NOT create publicly viewable issues for suspected security vulnerabilities. | |
| We will acknowledge receipt of your vulnerability report as soon as possible and strive to send you regular updates about our progress. If you're curious about the status of your disclosure please feel free to email us again. If you want to encrypt your disclosure email please email us to ask for our PGP key. | |
| Please refrain from requesting compensation for reporting vulnerabilities. If you want we will publicly acknowledge your responsible disclosure. We also try to make the issue public after the vulnerability is announced. Usually bug reports are made public after 72 hours, if possible. | |
| You are not allowed to search for security vulnerabilities on any hosted service of NanoAPI without the consent of the party hosting it. NanoAPI is open source software and can be installed for testing and security issues on your own infrastructure. |
|
Genius, working on it now |
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
erbesharat
requested changes
Oct 25, 2024
|
|
||
| Subject to the terms and conditions of this Agreement, You hereby grant to Nano API B.V. and to recipients of software distributed by Nano API B.V. a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by You that are necessarily infringed by Your Contribution(s) alone or by combination of Your Contribution(s) with the Work to which such Contribution(s) was submitted. If any entity institutes patent litigation against You or any other entity (including a cross-claim or counterclaim in a lawsuit) alleging that your Contribution, or the Work to which you have contributed, constitutes direct or contributory patent infringement, then any patent licenses granted to that entity under this Agreement for that Contribution or Work shall terminate as of the date such litigation is filed. | ||
|
|
||
| 4. You represent that You are legally entitled to grant the above license. You represent further that each of Your employees is authorized to submit Contributions on Your behalf, but excluding employees that are designated in writing by You as "Not authorized to submit Contributions on behalf of [name of Your corporation here]." Such designations of exclusion for unauthorized employees are to be submitted via email to legal@nzt.ventures. |
There was a problem hiding this comment.
Suggested change
| 4. You represent that You are legally entitled to grant the above license. You represent further that each of Your employees is authorized to submit Contributions on Your behalf, but excluding employees that are designated in writing by You as "Not authorized to submit Contributions on behalf of [name of Your corporation here]." Such designations of exclusion for unauthorized employees are to be submitted via email to legal@nzt.ventures. | |
| 4. You represent that You are legally entitled to grant the above license. You represent further that each of Your employees is authorized to submit Contributions on Your behalf, but excluding employees that are designated in writing by You as "Not authorized to submit Contributions on behalf of [name of Your corporation here]." Such designations of exclusion for unauthorized employees are to be submitted via email to [legal@nanoapi.io](mailto:legal@nanoapi.io) |
|
|
||
| 7. Should You wish to submit work that is not Your original creation, You may submit it to Nano API B.V. separately from any Contribution, identifying the complete details of its source and of any license or other restriction (including, but not limited to, related patents, trademarks, and license agreements) of which you are personally aware, and conspicuously marking the work as "Submitted on behalf of a third-party: [named here]". | ||
|
|
||
| 8. It is Your responsibility to notify Nano API B.V. when any change is required to the list of designated employees excluded from submitting Contributions on Your behalf per Section 4. Such notification should be sent via email to legal@nzt.ventures. |
There was a problem hiding this comment.
Suggested change
| 8. It is Your responsibility to notify Nano API B.V. when any change is required to the list of designated employees excluded from submitting Contributions on Your behalf per Section 4. Such notification should be sent via email to legal@nzt.ventures. | |
| 8. It is Your responsibility to notify Nano API B.V. when any change is required to the list of designated employees excluded from submitting Contributions on Your behalf per Section 4. Such notification should be sent via email to [legal@nanoapi.io](mailto:legal@nanoapi.io). |
|
@erbesharat fixed, I also created legal@nanoapi.io |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.