-
Notifications
You must be signed in to change notification settings - Fork 8
Add important community documentation #6
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| ## Code of Conduct | ||
|
|
||
| ### Our Pledge | ||
|
|
||
| In the interest of fostering an open and welcoming environment, we as | ||
| contributors and maintainers pledge to making participation in our project and | ||
| our community a harassment-free experience for everyone, regardless of age, body | ||
| size, disability, ethnicity, gender identity and expression, level of experience, | ||
| nationality, personal appearance, race, religion, or sexual identity and | ||
| orientation. | ||
|
|
||
| ### Our Standards | ||
|
|
||
| Examples of behavior that contributes to creating a positive environment | ||
| include: | ||
|
|
||
| - Using welcoming and inclusive language | ||
| - Being respectful of differing viewpoints and experiences | ||
| - Gracefully accepting constructive criticism | ||
| - Focusing on what is best for the community | ||
| - Showing empathy towards other community members | ||
|
|
||
| Examples of unacceptable behavior by participants include: | ||
|
|
||
| - The use of sexualized language or imagery and unwelcome sexual attention or | ||
| advances | ||
| - Trolling, insulting/derogatory comments, and personal or political attacks | ||
| - Public or private harassment | ||
| - Publishing others' private information, such as a physical or electronic | ||
| address, without explicit permission | ||
| - Other conduct which could reasonably be considered inappropriate in a | ||
| professional setting | ||
| - Other conduct which falls outside of [NanoAPI's Open-Source Manifesto](https://github.com/Nano-API/oss-manifesto/blob/main/README.md) | ||
|
|
||
| ### Our Responsibilities | ||
|
|
||
| Project maintainers are responsible for clarifying the standards of acceptable | ||
| behavior and are expected to take appropriate and fair corrective action in | ||
| response to any instances of unacceptable behavior. | ||
|
|
||
| Project maintainers have the right and responsibility to remove, edit, or | ||
| reject comments, commits, code, wiki edits, issues, and other contributions | ||
| that are not aligned to this Code of Conduct, or to ban temporarily or | ||
| permanently any contributor for other behaviors that they deem inappropriate, | ||
| threatening, offensive, or harmful. | ||
|
|
||
| ### Scope | ||
|
|
||
| This Code of Conduct applies both within project spaces and in public spaces | ||
| when an individual is representing the project or its community. Examples of | ||
| representing a project or community include using an official project e-mail | ||
| address, posting via an official social media account, or acting as an appointed | ||
| representative at an online or offline event. Representation of a project may be | ||
| further defined and clarified by project maintainers. | ||
|
|
||
| ### Enforcement | ||
|
|
||
| Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
| reported by contacting the project team at [info@nanoapi.io](mailto:info@nanoapi.io). All | ||
| complaints will be reviewed and investigated and will result in a response that | ||
| is deemed necessary and appropriate to the circumstances. The project team is | ||
| obligated to maintain confidentiality with regard to the reporter of an incident. | ||
| Further details of specific enforcement policies may be posted separately. | ||
|
|
||
| Project maintainers who do not follow or enforce the Code of Conduct in good | ||
| faith may face temporary or permanent repercussions as determined by other | ||
| members of the project's leadership. | ||
|
|
||
| ### Attribution | ||
|
|
||
| This Code of Conduct is adapted from the [ncc CoC](https://github.com/vercel/ncc/blob/main/CODE_OF_CONDUCT.md) which is itself adapted from the [Contributor Covenant][homepage], version 1.4, | ||
| available at [http://contributor-covenant.org/version/1/4][version] | ||
|
|
||
| [homepage]: http://contributor-covenant.org | ||
| [version]: http://contributor-covenant.org/version/1/4/ |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,114 @@ | ||
| # How to Contribute to NanoAPI | ||
|
|
||
| ## Contributor License Agreement | ||
| <!-- This section always comes first --> | ||
| - By submitting code as an individual you agree to the [individual contributor license agreement](/CLA/INDIVIDUAL_CONTRIBUTOR_LICENSE_AGREEMENT.md). | ||
| - By submitting code as an entity you agree to the [corporate contributor license agreement](/CLA/CORPORATE_CONTRIBUTOR_LICENSE_AGREEMENT.md). | ||
|
|
||
| ## Housekeeping | ||
|
|
||
| First off, thank you for being here. You dropped this: 👑 | ||
|
|
||
| Here are some guidelines to help you get started contributing to NanoAPI. | ||
|
|
||
| 1. Follow our [Code of Conduct](/.github/CODE_OF_CONDUCT.md). | ||
| 2. Check for open issues before creating a new one. | ||
| 3. We require an open issue for all pull requests. | ||
| 4. Help others by reviewing their pull requests. | ||
| 5. All donations we receive go directly back to our contributors. We’re here to support you when you successfully submit a PR to us. Your efforts help the community grow, and we want to give back to those who help make that possible! | ||
|
|
||
| ## How to File Issues | ||
|
|
||
| Make use of the issue templates, and label your issues appropriately. If you’re unsure about which label to use, don’t worry! We will help you choose the right one. | ||
|
|
||
| ## How to Submit a Pull Request | ||
|
|
||
| 1. Ensure an issue exists for the changes you want to make. | ||
| 2. Fork the repository. | ||
| 3. Create a new branch. | ||
| 4. Make your changes. | ||
| 5. Test your changes. | ||
| 6. Push your changes to your fork. | ||
| 1. Make sure to rebase before pushing. | ||
| 7. Submit a pull request. | ||
| 8. Follow the template and fill in all the sections. | ||
| 9. Wait for feedback. | ||
| 10. Make changes if necessary. | ||
| 11. Celebrate your success after your PR gets merged. The Codex Astartes supports this action. | ||
|
|
||
| ## Development Environment | ||
|
|
||
| You will need the following tools to develop NanoAPI: | ||
|
|
||
| - [Node.js](https://nodejs.org/en/) version 18 or higher. | ||
|
|
||
| ### Environment Set Up | ||
|
|
||
| We use the fork-and-pull model for contributions. Here’s how you can set up your development environment: | ||
|
|
||
| 1. Fork the repository. | ||
| 2. Clone your fork locally: | ||
|
|
||
| ```bash | ||
| $ git clone https://github.com/<your_username>/napi.git | ||
| ``` | ||
|
|
||
| 3. Enter the folder: | ||
|
|
||
| ```bash | ||
| $ cd napi | ||
| ``` | ||
|
|
||
| 4. Add the original repository as a remote: | ||
|
|
||
| ```bash | ||
| $ git remote add upstream https://github.com/nanoapi-io/napi.git | ||
| ``` | ||
|
|
||
| 5. Install the dependencies: | ||
|
|
||
| ```bash | ||
| $ npm install | ||
| ``` | ||
|
|
||
| ### Running the Project | ||
|
|
||
| When running locally, the UI and CLI must be run separately to avoid having to recreate production builds of the UI on each change. | ||
|
|
||
| To run the UI: | ||
|
|
||
| ```bash | ||
| $ npm run dev:app | ||
| ``` | ||
|
|
||
| To run the CLI: | ||
|
|
||
| ```bash | ||
| $ npm run dev:cli <command> | ||
| ``` | ||
|
|
||
| Running the `ui` command from the CLI will spin up a web server on your localhost. You can access the UI by navigating to `http://localhost:3000`. | ||
|
|
||
| > **Note:** In case of port collisions, the UI will automatically switch to the next available port. | ||
|
|
||
|
|
||
| ### Testing | ||
|
|
||
| ```bash | ||
| $ npm test | ||
| ``` | ||
|
|
||
| ### Linting | ||
|
|
||
| ```bash | ||
| $ npm run lint | ||
| ``` | ||
|
|
||
| ### Release Process | ||
|
|
||
| We are currently formalizing the release process. For now, the NanoAPI team will handle making regular releases. | ||
|
|
||
| ### Documentation | ||
|
|
||
| We are also building on the documentation process. For now, include any documentation changes in your PRs and we will add them into the main documentation. | ||
|
|
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| --- | ||
| name: Bug report | ||
| about: Create a report for a bug, regression, or unexpected behavior | ||
| title: "[BUG] " | ||
| labels: bug | ||
| assignees: '' | ||
| --- | ||
|
|
||
| <!--- Provide a general summary of the issue in the Title above --> | ||
|
|
||
| ## Description | ||
| <!--- Provide a more detailed introduction to the issue itself, and why you consider it to be a bug --> | ||
|
|
||
| ## Expected Behavior | ||
| <!--- Tell us what should happen --> | ||
|
|
||
| ## Actual Behavior | ||
| <!--- Tell us what happens instead --> | ||
|
|
||
| ## Possible Fix | ||
| <!--- Not obligatory, but suggest a fix or reason for the bug --> | ||
|
|
||
| ## Steps to Reproduce | ||
| <!--- Provide a link to a live example, or an unambiguous set of steps to --> | ||
| <!--- reproduce this bug. Include code to reproduce, if relevant --> | ||
| 1. | ||
| 2. | ||
| 3. | ||
| 4. | ||
|
|
||
| ## Context | ||
| <!--- How has this bug affected you? What were you trying to accomplish? --> | ||
|
|
||
| ## Your Environment | ||
| <!--- Include as many relevant details about the environment you experienced the bug in --> | ||
| * Version used: | ||
| * Environment name and version (e.g. Chrome 39, node.js 5.4): | ||
| * Operating System and version (desktop or mobile): | ||
| * Link to your project: | ||
|
|
||
| ### Config File | ||
|
|
||
| Paste your `.napirc` below | ||
| ```json | ||
| { | ||
| "your": "config" | ||
| } | ||
| ``` |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| --- | ||
| name: Feature request | ||
| about: Suggest an idea for this project | ||
| title: "[FEATURE] " | ||
| labels: enhancement | ||
| assignees: '' | ||
| --- | ||
|
|
||
| <!--- Provide a general summary of the issue in the Title above --> | ||
|
|
||
| ## Detailed Description | ||
| <!--- Provide a detailed description of the change or addition you are proposing --> | ||
|
|
||
| ## Context | ||
| <!--- Why is this change important to you? How would you use it? --> | ||
| <!--- How can it benefit other users? --> | ||
|
|
||
| ## Possible Implementation | ||
| <!--- Not obligatory, but suggest an idea for implementing addition or change --> | ||
|
|
||
| ## Your Environment | ||
| <!--- Include as many relevant details about the environment you experienced the bug in --> | ||
| * Version used: | ||
| * Environment name and version (e.g. Chrome 39, node.js 5.4): | ||
| * Operating System and version (desktop or mobile): | ||
| * Link to your project: | ||
|
|
||
| ### Config File | ||
|
|
||
| Paste your `.napirc` below | ||
| ```json | ||
| { | ||
| "your": "config" | ||
| } | ||
| ``` |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| ## Type of change | ||
| <!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> | ||
| - [ ] Bug fix (non-breaking change that fixes an issue) | ||
| - [ ] New feature (non-breaking change that adds functionality) | ||
| - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) | ||
| - [ ] Documentation update | ||
|
|
||
| ## Description | ||
|
|
||
| Please include a summary of the changes and the related issue. Explain the motivation behind this change. | ||
|
|
||
| ## Related Issue | ||
| <!--- This project only accepts pull requests related to open issues --> | ||
| <!--- If suggesting a new feature or change, please discuss it in an issue first --> | ||
| <!--- If fixing a bug, there should be an issue describing it with steps to reproduce --> | ||
| <!--- Please link to the issue here: --> | ||
|
|
||
| Issue Number: #<issue_number> | ||
|
|
||
| ## Motivation and Context | ||
| <!--- Why is this change required? What problem does it solve? --> | ||
|
|
||
| ## How Has This Been Tested? | ||
| <!--- Please describe in detail how you tested your changes. --> | ||
| <!--- Include details of your testing environment, and the tests you ran to --> | ||
| <!--- see how your change affects other areas of the code, etc. --> | ||
|
|
||
| ## Screenshots (if appropriate): | ||
|
|
||
| ## Checklist | ||
| <!--- Go over all the following points, and put an `x` in all the boxes that apply. --> | ||
| <!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> | ||
| - [ ] I have read the [contributing guidelines](CONTRIBUTING.md) | ||
| - [ ] My code follows the code style of this project. | ||
| - [ ] I have added tests that prove my fix is effective or that my feature works | ||
| - [ ] I have performed a self-review of my own code | ||
| - [ ] I have commented my code, particularly in hard-to-understand areas | ||
| - [ ] I have made corresponding changes to the documentation | ||
| - [ ] My changes generate no new warnings | ||
| - [ ] Any dependent changes have been merged and published |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| # Corporate contributor license agreement | ||
|
|
||
| You accept and agree to the following terms and conditions for Your present and future Contributions submitted to Nano API B.V. Except for the license granted herein to Nano API B.V. and recipients of software distributed by Nano API B.V., You reserve all right, title, and interest in and to Your Contributions. | ||
|
|
||
| 1. Definitions. | ||
|
|
||
| "You" (or "Your") shall mean the copyright owner or legal entity authorized by the copyright owner that is making this Agreement with Nano API B.V. For legal entities, the entity making a Contribution and all other entities that control, are controlled by, or are under common control with that entity are considered to be a single Contributor. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. | ||
|
|
||
| "Contribution" shall mean the code, documentation or other original works of authorship, including any modifications or additions to an existing work, that is submitted by You to Nano API B.V. for inclusion in, or documentation of, any of the products owned or managed by Nano API B.V. (the "Work"). For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to Nano API B.V. or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, Nano API B.V. for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by You as "Not a Contribution." | ||
|
|
||
| 2. Grant of Copyright License. | ||
|
|
||
| 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 copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute Your Contributions and such derivative works. | ||
|
|
||
| 3. Grant of Patent License. | ||
|
|
||
| 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. | ||
|
|
||
| 1. 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). | ||
|
|
||
| 2. You represent that each of Your Contributions is Your original creation (see section 7 for submissions on behalf of others). | ||
|
|
||
| 3. You are not expected to provide support for Your Contributions, except to the extent You desire to provide support. You may provide support for free, for a fee, or not at all. Unless required by applicable law or agreed to in writing, You provide Your Contributions on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. | ||
|
|
||
| 4. 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]". | ||
|
|
||
| 5. 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). | ||
|
|
||
| This text is licensed under the [Creative Commons Attribution 3.0 License](https://creativecommons.org/licenses/by/3.0/) and the original source is the Google Open Source Programs Office. |
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What do you think about a more detailed version which also mentions our "hosted" version for future.