Skip to content

Latest commit

 

History

History
66 lines (45 loc) · 2.55 KB

CONTRIBUTING.md

File metadata and controls

66 lines (45 loc) · 2.55 KB
Raw

Contributing

Feel free to contribute to this module.

As a general advice it is always a good idea to raise an issue before creating a new pull request.
This ensures that we don't have to reject pull requests that are not aligning with our roadmap and not wasting your valuable time.

Reporting Bugs

If you encounter a bug, please open an issue on the GitHub repository.
Be sure to include as much information as possible to help us understand and reproduce the problem.

Feature Requests

If you have an idea for a new feature or enhancement, please feel free to open an issue and describe it.
We'd love to hear your suggestions!

Testing

Please check our testing guidelines.

Development Workflow

ns-build package

  1. Edit the examples/[selected_example]/node_modules/ns-build/bin/ns-build.sh file.
  2. Run npm run ns-build to build the Next.js app using the custom script.
  3. Re-deploy the module.
  4. Make sure your changes are applied and existing functionality is not broken.
  5. Copy the updates you made to the packages/ns-build/bin/ns-build.sh file.

ns-img-rdr packeges

  1. Make your changes
  2. Run npm run prepare-lambda
  3. Copy packages/ns-img-rdr/source.zip to examples/nextjs-v13/deployments/ns-img-rdr/source.zip
  4. Re-deploy the module.
  5. Make sure your changes are applied and existing functionality is not broken.

ns-img-opt packeges

  1. Make your changes
  2. Run npm run prepare-lambda
  3. Copy packages/ns-img-opt/source.zip to examples/nextjs-v13/deployments/ns-img-opt/source.zip
  4. Re-deploy the module.
  5. Make sure your changes are applied and existing functionality is not broken.

next_serverless module

  1. Switch to the local source
module "tf_next" {
- source  = "emyriounis/nextjs-serverless/aws"
- version = "1.0.0"
+ source = "../../../"
  ...
}
  1. Make your changes to the terraform files
  2. Validate them (terraform validate)
  3. Re-deploy the module.
  4. Make sure your changes are applied and existing functionality is not broken.
  5. Follow existing format (terraform fmt -recursive)

Issues

If you face any problem, feel free to open an issue.