|
| 1 | +# Contribute to `scaleway-qaas-client` |
| 2 | + |
| 3 | +`scaleway-qaas-client` is Apache 2.0 licensed and accepts contributions via GitHub. |
| 4 | +This document will cover how to contribute to the project and report issues. |
| 5 | + |
| 6 | +## Topics |
| 7 | + |
| 8 | +- [Reporting Security Issues](#reporting-security-issues) |
| 9 | +- [Reporting Issues](#reporting-issues) |
| 10 | +- [Suggesting feature](#suggesting-feature) |
| 11 | +- [Contributing Code](#contributing-code) |
| 12 | +- [Community Guidelines](#community-guidelines) |
| 13 | + |
| 14 | +## Reporting security issues |
| 15 | + |
| 16 | +At Scaleway we take security seriously. |
| 17 | +If you have any issue regarding security, please notify us by sending an email to [security@scaleway.com](mailto:security@scaleway.com). |
| 18 | + |
| 19 | +Please _DO NOT_ create a GitHub issue. |
| 20 | + |
| 21 | +We will follow up with you promptly with more information and a plan for remediation. |
| 22 | +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. |
| 23 | + |
| 24 | +## Reporting issues |
| 25 | + |
| 26 | +A great way to contribute to the project is to send a detailed report when you encounter a bug. |
| 27 | +We always appreciate a well-written, thorough bug report, and will thank you for it! |
| 28 | +Before opening a new issue, we appreciate you reviewing open issues to see if there are any similar requests. |
| 29 | +If there is a match, thumbs up the issue with a 👍 and leave a comment if you have additional information. |
| 30 | + |
| 31 | +When reporting an issue, include the following: |
| 32 | + |
| 33 | +- The version of `scaleway-qaas-client` you are using |
| 34 | +- Python version |
| 35 | +- The target backend is applicable |
| 36 | + |
| 37 | +## Suggesting a feature |
| 38 | + |
| 39 | +When requesting a feature, some of the questions we want to answer are: |
| 40 | + |
| 41 | +- What value does this feature bring to end users? |
| 42 | +- How urgent is the need (nice to have feature or need to have)? |
| 43 | +- Does this align with the goals of `scaleway-qaas-client`? |
| 44 | + |
| 45 | +## Contributing code |
| 46 | + |
| 47 | +### Submit code |
| 48 | + |
| 49 | +To submit code: |
| 50 | + |
| 51 | +- Create a fork of the project |
| 52 | +- Create a topic branch from where you want to base your work (usually master) |
| 53 | +- Add tests to cover contributed code |
| 54 | +- Push your commit(s) to your topic branch on your fork |
| 55 | +- Open a pull request against `scaleway-qaas-client` master branch that follows [PR guidelines](#pull-request-guidelines) |
| 56 | + |
| 57 | +The maintainers of `scaleway-qaas-client` use a "Let's Get This Merged" (LGTM) message in the pull request to note that the commits are ready to merge. |
| 58 | +After one or more maintainer states LGTM, we will merge. |
| 59 | +If you have questions or comments on your code, feel free to correct these in your branch through new commits. |
| 60 | + |
| 61 | +### Pull Request Guidelines |
| 62 | + |
| 63 | +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. |
| 64 | + |
| 65 | +- **Pull Request title should be clear** on what is being fixed or added to the code base. |
| 66 | + If you are addressing an open issue, please start the title with "fix: #XXX" or "feature: #XXX" |
| 67 | +- **Keep it readable for human reviewers** and prefer a subset of functionality (code) with tests and documentation over delivering them separately |
| 68 | +- **Don't forget commenting code** to help reviewers understand |
| 69 | +- **Notify Work In Progress PRs** by prefixing the title with `[WIP]` |
| 70 | +- **Please, keep us updated.** |
| 71 | + We will try our best to merge your PR, but please notice that PRs may be closed after 30 days of inactivity. |
| 72 | + |
| 73 | +Your pull request should be rebased against the current master branch. Please do not merge |
| 74 | +the current master branch in with your topic branch, nor use the Update Branch button provided |
| 75 | +by GitHub on the pull request page. |
| 76 | + |
| 77 | +Keep in mind only the **Pull Request Title** will be used as commit message as we stash all commits on merge. |
| 78 | + |
| 79 | +## Community guidelines |
| 80 | + |
| 81 | +Thank you for reading through all of this, if you have any question feel free to [reach us](README.md#reach-us)! |
0 commit comments