Skip to content

Latest commit

 

History

History
125 lines (80 loc) · 3.58 KB

CONTRIBUTING.md

File metadata and controls

125 lines (80 loc) · 3.58 KB
Raw

How to Contribute to NanoAPI

Contributor License Agreement

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.
  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. Don't panic.
  2. Ensure an issue exists for the changes you want to make.
  3. Fork the repository.
  4. Create a new branch.
  5. Make your changes.
  6. Test your changes.
  7. Push your changes to your fork.
    1. Make sure to rebase before pushing.
  8. Submit a pull request.
  9. Follow the template and fill in all the sections.
  10. Wait for feedback.
  11. Make changes if necessary.
  12. 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:

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:
$ git clone https://github.com/<your_username>/napi.git
  1. Enter the folder:
$ cd napi
  1. Add the original repository as a remote:
$ git remote add upstream https://github.com/nanoapi-io/napi.git
  1. Install the dependencies:
$ 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:

$ npm run dev:app

To run the CLI:

$ 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

$ npm test

Linting

$ npm run lint

Release Process

We are currently formalizing the release process. For now, the NanoAPI team will handle making regular releases.

To ensure releases run smoothly, put the content of your changes in our CHANGELOG file.

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.

Discussions vs Issues

We use GitHub Discussions for general questions, ideas, and feedback. If you have a question, please use the Discussions tab. If you have a bug report or feature request, please use the Issues tab.

That's it for this guide for now. So long, and thanks for all the fish! 🚀