Debian Codegraph @

new/.github/CONTRIBUTING.md

raw
1 # Contribute
2
3 ## Introduction
4
5 First, thank you for considering contributing to rollup! It's people like you that make the open source community such a great community! 😊
6
7 We welcome any type of contribution, not only code. You can help with
8
9 - **QA**: file bug reports, the more details you can give the better (i.e. [REPL](https://rollupjs.org/repl/)-links or repos that demonstrate the specific issue)
10 - **Marketing**: writing blog posts, howto's, printing stickers, ...
11 - **Community**: presenting the project at meetups, organizing a dedicated meetup for the local community, ...
12 - **Code**: take a look at the [open issues](https://github.com/rollup/plugins/issues). Even if you can't write code, commenting on them, showing that you care about a given issue matters. It helps us triage them.
13 - **Money**: we welcome financial contributions in full transparency on our [open collective](https://opencollective.com/rollup).
14
15 ## Your First Contribution
16
17 Working on your first Pull Request? You can learn how from this _free_ series, [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github).
18
19 ## Submitting code
20
21 Any code change should be submitted as a pull request. Our guidelines for Pull Requests:
22
23 - Please fill in our template in its entirety. Please don't reformat it or modify it
24 - The description should explain what the code does and give steps to execute it
25 - The pull request should also contain tests
26 - Before submitting your Pull Request, please lint your changes by running `pnpm lint` in the root directory
27 - If any checks fail for your Pull Request, please resolve them. Always feel free to ask for help if unable to resolve issues with checks
28
29 ## Testing packages
30
31 Some packages use Vitest for tests. When converting or running tests locally inside a package directory (e.g. `packages/alias`):
32
33 - Tests import the package under test via `~package`. A shared config at `.config/vitest.config.mts` provides a runtime alias that resolves `~package` to the current working directory.
34 - Snapshots are written alongside each test under a local `.snapshots` directory.
35
36 Example (from a package directory):
37
38 ```
39 pnpm build
40 pnpm test
41 ```
42
43 ## Code review process
44
45 The bigger the pull request, the longer it will take to review and merge. Try to break down large pull requests in smaller chunks that are easier to review and merge.
46
47 It is also always helpful to have some context for your pull request. What was the purpose? Why does it matter to you? Does it resolve any known Github issues? Adding a line "resolves #<issue number>" (e.g. "resolves #23") to the description of your pull request or of a specific commit will automatically close this issue once the pull request is merged.
48
49 ## Financial contributions
50
51 We also welcome financial contributions in full transparency on our [open collective](https://opencollective.com/rollup).
52 Anyone can file an expense. If the expense makes sense for the development of the community, it will be "merged" in the ledger of our open collective by the core contributors and the person who filed the expense will be reimbursed.
53
54 ## Questions
55
56 If you require technical assistance, [Stackoverflow](https://stackoverflow.com/questions/tagged/rollupjs) or [Rollup Discord](https://is.gd/rollup_chat) are usually the best places to start.
57 You can also create an [issue](issue) (protip: do a quick search first to see if someone else didn't ask the same question before!).
58
59 ## Credits
60
61 ### Contributors
62
63 Thank you to all the people who have already contributed to rollup!
64 <a href="graphs/contributors"><img src="https://opencollective.com/rollup/contributors.svg?width=890" /></a>
65
66 ### Backers
67
68 Thank you to all our backers! [[Become a backer](https://opencollective.com/rollup#backer)]
69
70 <a href="https://opencollective.com/rollup#backers" target="_blank"><img src="https://opencollective.com/rollup/backers.svg?width=890"></a>
71
72 ### Sponsors
73
74 Thank you to all our sponsors! (please ask your company to also support this open source project by [becoming a sponsor](https://opencollective.com/rollup#sponsor))
75
76 <a href="https://opencollective.com/rollup/sponsor/0/website" target="_blank"><img src="https://opencollective.com/rollup/sponsor/0/avatar.svg"></a>
77 <a href="https://opencollective.com/rollup/sponsor/1/website" target="_blank"><img src="https://opencollective.com/rollup/sponsor/1/avatar.svg"></a>
78 <a href="https://opencollective.com/rollup/sponsor/2/website" target="_blank"><img src="https://opencollective.com/rollup/sponsor/2/avatar.svg"></a>
79 <a href="https://opencollective.com/rollup/sponsor/3/website" target="_blank"><img src="https://opencollective.com/rollup/sponsor/3/avatar.svg"></a>
80 <a href="https://opencollective.com/rollup/sponsor/4/website" target="_blank"><img src="https://opencollective.com/rollup/sponsor/4/avatar.svg"></a>
81 <a href="https://opencollective.com/rollup/sponsor/5/website" target="_blank"><img src="https://opencollective.com/rollup/sponsor/5/avatar.svg"></a>
82 <a href="https://opencollective.com/rollup/sponsor/6/website" target="_blank"><img src="https://opencollective.com/rollup/sponsor/6/avatar.svg"></a>
83 <a href="https://opencollective.com/rollup/sponsor/7/website" target="_blank"><img src="https://opencollective.com/rollup/sponsor/7/avatar.svg"></a>
84 <a href="https://opencollective.com/rollup/sponsor/8/website" target="_blank"><img src="https://opencollective.com/rollup/sponsor/8/avatar.svg"></a>
85 <a href="https://opencollective.com/rollup/sponsor/9/website" target="_blank"><img src="https://opencollective.com/rollup/sponsor/9/avatar.svg"></a>
86
87 <!-- This `CONTRIBUTING.md` is based on @nayafia's template https://github.com/nayafia/contributing-template -->