Skip to content

Latest commit

 

History

History
90 lines (60 loc) · 4.32 KB

CONTRIBUTING.md

File metadata and controls

90 lines (60 loc) · 4.32 KB
Raw

Contribute to scaleway-sdk-js

scaleway-sdk-js is Apache 2.0 licensed and accepts contributions via GitHub. This document will cover how to contribute to the project and report issues.

Topics

Reporting security issues

At Scaleway we take security seriously. If you have any issue regarding security, please notify us by sending an email to [email protected].

Please DO NOT create a GitHub issue.

We will follow up with you promptly with more information and a plan for remediation. We currently do not offer a paid security bounty program, but we would love to send some Scaleway swag your way along with our deepest gratitude for your assistance in making Scaleway a more secure Cloud ecosystem.

Reporting issues

A great way to contribute to the project is to send a detailed report when you encounter a bug. We always appreciate a well-written, thorough bug report, and will thank you for it! Before opening a new issue, we appreciate you reviewing open issues to see if there are any similar requests. If there is a match, thumbs up the issue with a 👍 and leave a comment if you have additional information.

When reporting an issue, include the following:

  • The version of scaleway-sdk-js you are using (e.g. v1.0.0-beta1, v2.0.0, master, ...)
  • The environment and its version (e.g. NodeJS v18.10)

Suggesting a feature

When requesting a feature, some of the questions we want to answer are:

  • What value does this feature bring to end users?
  • How urgent is the need (nice to have feature or need to have)?
  • Does this align with the goals of scaleway-sdk-js?

Contributing code

Part of this repo is automatically generated from our protocol buffer monorepo. This enables us to keep Scaleway toolings up to date with the latest version of our APIs (developer website, CLI, SDKs, etc).

Generated files and folders are located in scaleway-sdk-js/packages/clients/api. They always start with the following line:

// This file was automatically generated. DO NOT EDIT.

Submit code

To submit code:

  • Create a fork of the project
  • Create a topic branch from where you want to base your work (usually master)
  • Add tests to cover contributed code
  • Push your commit(s) to your topic branch on your fork
  • Open a pull request against scaleway-sdk-js master branch that follows PR guidelines

The maintainers of scaleway-sdk-js use a "Let's Get This Merged" (LGTM) message in the pull request to note that the commits are ready to merge. After one or more maintainer states LGTM, we will merge. If you have questions or comments on your code, feel free to correct these in your branch through new commits.

Pull Request Guidelines

The goal of the following guidelines is to have Pull Requests (PRs) that are fairly easy to review and comprehend, and code that is easy to maintain in the future.

  • Pull Request title should be clear on what is being fixed or added to the code base. If you are addressing an open issue, please start the title with "fix(api): #XXX" or "feat: #XXX"
  • Keep it readable for human reviewers and prefer a subset of functionality (code) with tests and documentation over delivering them separately
  • Don't forget commenting code to help reviewers understand the modification
  • Notify Work In Progress PRs by prefixing the title with Draft:
  • Please, keep us updated. We will try our best to merge your PR, but please notice that PRs may be closed after 30 days of inactivity.

Your pull request should be rebased against the current master branch. Please do not merge the current master branch in with your topic branch, nor use the Update Branch button provided by GitHub on the pull request page.

Keep in mind only the Pull Request Title will be used as commit message as we stash all commits on merge.

Community guidelines

See CODE_OF_CONDUCT.md.

Thank you for reading through all of this, if you have any question feel free to reach us!