# Contributing to CoreDNS Welcome! Our community focuses on helping others and making CoreDNS the best it can be. We gladly accept contributions and encourage you to get involved! ## Bug reports First, please [search this repository](https://github.com/coredns/coredns/search?q=&type=Issues&utf8=%E2%9C%93) with a variety of keywords to ensure your bug is not already reported. If not, [open an issue](https://github.com/coredns/coredns/issues) and answer the questions so we can understand and reproduce the problematic behavior. The burden is on you to convince us that it is actually a bug in CoreDNS. This is easiest to do when you write clear, concise instructions so we can reproduce the behavior (even if it seems obvious). The more detailed and specific you are, the faster we will be able to help you. Check out [How to Report Bugs Effectively](http://www.chiark.greenend.org.uk/~sgtatham/bugs.html). Please be kind. :smile: Remember that CoreDNS comes at no cost to you, and you're getting free help. ## Minor improvements and new tests Submit [pull requests](https://github.com/coredns/coredns/pulls) at any time. Make sure to write tests to assert your change is working properly and is thoroughly covered. ## Proposals, suggestions, ideas, new features First, please [search](https://github.com/coredns/coredns/search?q=&type=Issues&utf8=%E2%9C%93) with a variety of keywords to ensure your suggestion/proposal is new. If so, you may open either an issue or a pull request for discussion and feedback. The advantage of issues is that you don't have to spend time actually implementing your idea, but you should still describe it thoroughly. The advantage of a pull request is that we can immediately see the impact the change will have on the project, what the code will look like, and how to improve it. The disadvantage of pull requests is that they are unlikely to get accepted without significant changes, or it may be rejected entirely. Don't worry, that won't happen without an open discussion first. If you are going to spend significant time implementing code for a pull request, best to open an issue first and "claim" it and get feedback before you invest a lot of time. ## Vulnerabilities If you've found a vulnerability that is serious, please email: . If it's not a big deal, a pull request will probably be faster. ## Git Hook We use `golint` and `go vet` as tools to warn use about things (noted golint is obnoxious sometimes, but still helpful). Add the following script as a git `post-commit` in `.git/hooks/post-commit` and make it executable. ~~~ sh #!/bin/bash # : # The script takes no parameters and its exit status does not affect the commit in any way. You can # use git # rev-parse HEAD to get the new commit’s SHA1 hash, or you can use git log -l HEAD to get # all of its # information. for d in *; do if [[ "$d" == "vendor" ]]; then continue fi if [[ "$d" == "logo" ]]; then continue fi if [[ ! -d "$d" ]]; then continue fi golint "$d"/... done ~~~ ## Updating Dependencies We use Golang's [`dep`](https://github.com/golang/dep) as the tool to manage vendor dependencies. The tool could be obtained through: ```sh $ go get -u github.com/golang/dep/cmd/dep ``` Use the following to update the locked versions of all dependencies ```sh $ dep ensure -update ``` To add a dependency to the project, you might run ```sh $ dep ensure github.com/pkg/errors ``` After the dependencies have been updated or added, you might run the following to prune vendored packages: ```sh $ dep prune ``` Please refer to Golang's [`dep`](https://github.com/golang/dep) for more details. # Thank you Thanks for your help! CoreDNS would not be what it is today without your contributions. s'>dylan/cli-fixes Unnamed repository; edit this file 'description' to name the repository.
aboutsummaryrefslogtreecommitdiff
AgeCommit message (Expand)AuthorFilesLines
2023-09-13fix(BunFile.slice) fix slice when length is greater than the size (#5186)Gravatar Ciro Spaciari 2-3/+15
2023-09-13fix(doc): Add "compilerOptions" to bun-types README.md (#5325)Gravatar Patrick Klitzke 1-3/+5
2023-09-13fix(node:dns): fix the crash. (#5200)Gravatar Ai Hoshino 3-15/+66
2023-09-13fix(console.log) fix printing long custom format (#5164)Gravatar Ciro Spaciari 4-2/+38
2023-09-13feat(nodejs): implement `os.availableParallelism` (#5109)Gravatar WingLim 3-3/+10
2023-09-13Make --watch instant (#5236)Gravatar Jarred Sumner 7-56/+190
2023-09-13fix(runtime): require cache should not include unevaluated ESM modules. (#5233)Gravatar dave caruso 6-8/+40
2023-09-13Fixed api & cli docs typo. (#5262)Gravatar James Gordo 3-4/+4
2023-09-13chore(docs): include missing links to Node.js APIs (#5281)Gravatar Steven 1-2/+2
2023-09-13docs(guide): fix expect assertion example in guide for `spyOn` (#5294)Gravatar wing 1-1/+1
2023-09-13add uninstall instructions (#5311)Gravatar Andrew Brown 1-0/+24
2023-09-13docs: update lockfile diff instructions (#5275)Gravatar Guilherme J. Tramontina 1-3/+7
2023-09-13fix(node/fetch): Make data URL fetch consistent with node (#5126)Gravatar David Hewitt 2-7/+37
2023-09-13avoid inserting extraneous"accept-encoding" header (#5057)Gravatar iidebyo 2-1/+22
2023-09-13docs(runtime): fix plugins loader extensions typo (#5250)Gravatar Zong 1-1/+1
2023-09-13chore: make comment grammatically correct (#5140)Gravatar Gareth Jones 1-1/+1
2023-09-13Add informative message on 'bun create react' (#5248)Gravatar Colin McDonnell 1-0/+22
2023-09-13docs(runtime): fix jsx FragmentFactory output example (#5243)Gravatar Zong 1-1/+1
2023-09-13file.exists() needs to be awaited to get the value (#5061)Gravatar amt8u 1-1/+1
2023-09-13Update discordjs.md (#5227)Gravatar Antonin CLAUZIER 1-1/+1
2023-09-13decode regex if needed (#5167)Gravatar Dylan Conway 5-126/+167
2023-09-13Correct the configuration file names. (#5234)Gravatar Nathan Hammond 2-2/+2
2023-09-12Update tsconfig.json for bun initGravatar Colin McDonnell 1-1/+1
2023-09-12js/node/stream.js: call write() callback when encoding is not provided (#4841)Gravatar cfal 2-3/+7
2023-09-12docs: Made bun-types install as dev dependency in example (#5120)Gravatar Gordon Goldbach 1-1/+1
2023-09-12Various docs (#5201)Gravatar Colin McDonnell 4-4/+147
2023-09-12Use git's --global flag for lockfile diffs instead of manually modifying conf...Gravatar Southpaw 1-17/+7
2023-09-12docs: fix typo in import.meta.resolve (#5146)Gravatar Jonathan Neal 1-1/+1
2023-09-12Update hot.md (#4990)Gravatar Nazeel 1-1/+1
2023-09-12Update simple.md (#4997)Gravatar Tom Redman 1-1/+1
2023-09-12fix typo and grammar errors (#5046)Gravatar xnacly 1-3/+3
2023-09-12clang and llvm on arch install v16, update to use v15 (#5069)Gravatar mi4uu 1-1/+10
2023-09-12Add missing full stop on nodejs-apis.md (#5072)Gravatar Diogo Goncalves 1-5/+5
2023-09-12udate README.md (#5127)Gravatar Toby 1-1/+1
2023-09-12docs: fix typos (#5151)Gravatar Samuel Rigaud 17-18/+18
2023-09-12fix lifecycle docu (#5159)Gravatar Thomas Rupprecht 1-4/+4
2023-09-12Clean up Modules docGravatar Colin McDonnell 1-66/+73