cloudflare/.github
Publicmirrored fromhttps://github.com/cloudflare/.githubAvailable
CONTRIBUTING.md
56lines · modecode
| 1 | # Contributing |
| 2 | |
| 3 | Welcome to Cloudflare OpenSource! We're super excited to have you here. This document contains |
| 4 | the best practices for contributing to our repositories. |
| 5 | |
| 6 | ## Filing an Issue |
| 7 | |
| 8 | If you are using one of our open source projects- you'll likely begin interacting with us by |
| 9 | filing an issue. Regardless of whether you think the issue is with the project itself, if you're |
| 10 | having trouble using the project, feel free to file an issue on the repo. |
| 11 | |
| 12 | **If you have a feature request, please file an issue before making a PR.** Everyone's time is |
| 13 | incredibley valuable, so if you have an idea for a feature, please file an issue. This way we |
| 14 | can have a discussion with you, and the community, about the design, before you have sunk a |
| 15 | bunch of time into developing it. |
| 16 | |
| 17 | **You do not need to file an issue for small fixes.** If you are fixing a typo or refactoring |
| 18 | a bit of code, you likely don't need to file an issue. This is a judgement call, and *sometimes* |
| 19 | we may review your PR and ask you to file an issue if we expect there are larger design decisions |
| 20 | to be made. |
| 21 | |
| 22 | **Each repository has an Issue Template.** This helps us make sure that you can give us the most |
| 23 | information about your issue upfront, so we can limit the amount of back and forth required |
| 24 | before your issue can be resolved. Do your best to fill it out, but if you have trouble, it's |
| 25 | ok to file an incomplete issue template. |
| 26 | |
| 27 | ## Making a PR |
| 28 | |
| 29 | **If you are considering filing a pull request, make sure that there's an issue filed for the work |
| 30 | you'd like to do.** There might be some discussion required! Filing an issue first will help ensure |
| 31 | that the work you put into your pull request will get merged. |
| 32 | |
| 33 | Once your PR is made, it will be labelled *needs review*. A maintainer will review your PR as soon |
| 34 | as they can. The reviewer may ask for changes- they will mark the PR as *changes requested* and |
| 35 | *work in progress* and will give you details about the requested changes. Feel free to ask lots of |
| 36 | questions! The maintainers are there to help you! |
| 37 | |
| 38 | ### IDE Configuration Files |
| 39 | |
| 40 | Machine specific configuration files may be generaged by your IDE while working on the project. Please make sure to add these files to a global .gitignore so they are kept from accidentally being commited to the project and causing issues for other contributors. |
| 41 | |
| 42 | Some examples of these files are the .idea folder created by JetBrains products (WebStorm, IntelliJ, etc) as well as .vscode created by Visual Studio Code for workspace specific settings. |
| 43 | |
| 44 | For help setting up a global `.gitignore` check out this [GitHub article](https://help.github.com/articles/ignoring-files/#create-a-global-gitignorea)! |
| 45 | |
| 46 | ## Conduct |
| 47 | |
| 48 | Cloudflare OpenSource follows the [Contributor Covenant Code of Conduct]. You can find a copy in each |
| 49 | of our repositories. Violating the CoC could result in a warning or a ban to any and all repositories |
| 50 | in this origanization. |
| 51 | |
| 52 | [Contributor Covenant Code of Conduct]: CODE_OF_CONDUCT.md |
| 53 | |
| 54 | ## Contact |
| 55 | |
| 56 | If you have any questions, please reach out to [opensource@cloudflare.com](mailto:opensource@cloudflare.com). |
| 57 | |