Skip to content

Commit 5eb1ff9

Browse files
authored
[docs] publish roadmap. add process section to contributor's guide and re-organize a bit (sveltejs#7965)
1 parent 43905cc commit 5eb1ff9

File tree

2 files changed

+56
-43
lines changed

2 files changed

+56
-43
lines changed

CONTRIBUTING.md

+51-43
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ There are many ways to contribute to Svelte, and many of them do not involve wri
1313

1414
- Simply start using Svelte. Go through the [Getting Started](https://svelte.dev/docs#getting-started) guide. Does everything work as expected? If not, we're always looking for improvements. Let us know by [opening an issue](#reporting-new-issues).
1515
- Look through the [open issues](https://github.com/sveltejs/svelte/issues). A good starting point would be issues tagged [good first issue](https://github.com/sveltejs/svelte/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22). Provide workarounds, ask for clarification, or suggest labels. Help [triage issues](#triaging-issues-and-pull-requests).
16-
- If you find an issue you would like to fix, [open a pull request](#your-first-pull-request).
16+
- If you find an issue you would like to fix, [open a pull request](#pull-requests).
1717
- Read through our [tutorials](https://svelte.dev/tutorial/basics). If you find anything that is confusing or can be improved, you can make edits by clicking "Edit this chapter" at the bottom left of the tutorial page.
1818
- Take a look at the [features requested](https://github.com/sveltejs/svelte/labels/feature%20request) by others in the community and consider opening a pull request if you see something you want to work on.
1919

@@ -24,65 +24,63 @@ Contributions are very welcome. If you think you need help planning your contrib
2424
One great way you can contribute to the project without writing any code is to help triage issues and pull requests as they come in.
2525

2626
- Ask for more information if you believe the issue does not provide all the details required to solve it.
27-
- Suggest [labels](https://github.com/sveltejs/svelte/labels) that can help categorize issues.
2827
- Flag issues that are stale or that should be closed.
2928
- Ask for test plans and review code.
3029

31-
## Bugs
30+
## Our process
3231

33-
We use [GitHub issues](https://github.com/sveltejs/svelte/issues) for our public bugs. If you would like to report a problem, take a look around and see if someone already opened an issue about it. If you are certain this is a new unreported bug, you can submit a [bug report](#reporting-new-issues).
32+
### RFCs
3433

35-
If you have questions about using Svelte, contact us on Discord at [svelte.dev/chat](https://svelte.dev/chat), and we will do our best to answer your questions.
34+
If you'd like to propose an implementation for a large new feature or change then please [create an RFC](https://github.com/sveltejs/rfcs) to discuss it up front.
3635

37-
If you see anything you'd like to be implemented, create a [feature request issue](https://github.com/sveltejs/svelte/issues/new?template=feature_request.md)
36+
### Roadmap
3837

39-
## Reporting new issues
38+
When deciding where to contribute, you may wish to take a look at [our roadmap](https://svelte.dev/roadmap). The Svelte team generally works on a single major effort at a time. This has a couple benefits for us as maintainers. First, it allows us to focus and make noticeable progress in an area being proactive rather than reactive. Secondly, it allows us to handle related issues and PRs together. By batching issues and PRs together we’re able to ensure implementations and fixes holistically address the set of problems and use cases encountered by our users.
4039

41-
When [opening a new issue](https://github.com/sveltejs/svelte/issues/new/choose), always make sure to fill out the issue template. **This step is very important!** Not doing so may result in your issue not being managed in a timely fashion. Don't take this personally if this happens, and feel free to open a new issue once you've gathered all the information required by the template.
40+
### Maintainer meetings
4241

43-
- **One issue, one bug:** Please report a single bug per issue.
44-
- **Provide reproduction steps:** List all the steps necessary to reproduce the issue. The person reading your bug report should be able to follow these steps to reproduce your issue with minimal effort. If possible, use the [REPL](https://svelte.dev/repl) to create your reproduction.
42+
The maintainers meet on the final Saturday of each month. While these meetings are not open publicly, we will report back by leaving a comment on each issue discussed. We will generally discuss items aligning with our roadmap, but major PRs needing discussion amongst the maintainers can be added to the agenda for the monthly maintainer’s meeting. However, we typically are only able to get to a couple of items that are not aligned with our current priority.
4543

46-
## RFCs
44+
### Prioritization
4745

48-
If you'd like to propose an implementation for a large new feature or change then please [create an RFC](https://github.com/sveltejs/rfcs) to discuss it up front.
46+
We do our best to review PRs and RFCs as they are sent, but it is difficult to keep up. We welcome help in reviewing PRs, RFC, and issues. If an item aligns with the current priority on our [roadmap](https://svelte.dev/roadmap), it is more likely to be reviewed quickly. PRs to the most important and active ones repositories get reviewed more quickly while PRs to smaller inactive repos may sit for a bit before we periodically come by and review the pending PRs in a batch.
4947

50-
## Installation
48+
## Bugs
5149

52-
1. Ensure you have [npm](https://www.npmjs.com/get-npm) installed.
53-
1. After cloning the repository, run `npm install` in the root of the repository.
54-
1. To start a development server, run `npm run dev`.
50+
We use [GitHub issues](https://github.com/sveltejs/svelte/issues) for our public bugs. If you would like to report a problem, take a look around and see if someone already opened an issue about it. If you are certain this is a new unreported bug, you can submit a [bug report](#reporting-new-issues).
5551

56-
## Pull requests
52+
If you have questions about using Svelte, contact us on Discord at [svelte.dev/chat](https://svelte.dev/chat), and we will do our best to answer your questions.
5753

58-
### Your first pull request
54+
If you see anything you'd like to be implemented, create a [feature request issue](https://github.com/sveltejs/svelte/issues/new?template=feature_request.md)
5955

60-
So you have decided to contribute code back to upstream by opening a pull request. You've invested a good chunk of time, and we appreciate it. We will do our best to work with you and get the PR looked at.
56+
### Reporting new issues
6157

62-
Working on your first Pull Request? You can learn how from this free video series:
58+
When [opening a new issue](https://github.com/sveltejs/svelte/issues/new/choose), always make sure to fill out the issue template. **This step is very important!** Not doing so may result in your issue not being managed in a timely fashion. Don't take this personally if this happens, and feel free to open a new issue once you've gathered all the information required by the template.
59+
60+
- **One issue, one bug:** Please report a single bug per issue.
61+
- **Provide reproduction steps:** List all the steps necessary to reproduce the issue. The person reading your bug report should be able to follow these steps to reproduce your issue with minimal effort. If possible, use the [REPL](https://svelte.dev/repl) to create your reproduction.
6362

64-
[**How to Contribute to an Open Source Project on GitHub**](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github)
63+
## Pull requests
6564

6665
### Proposing a change
6766

6867
If you would like to request a new feature or enhancement but are not yet thinking about opening a pull request, you can also file an issue with [feature template](https://github.com/sveltejs/svelte/issues/new?template=feature_request.yml).
6968

7069
If you're only fixing a bug, it's fine to submit a pull request right away, but we still recommend that you file an issue detailing what you're fixing. This is helpful in case we don't accept that specific fix but want to keep track of the issue.
7170

72-
### Sending a pull request
71+
Small pull requests are much easier to review and more likely to get merged.
7372

74-
Small pull requests are much easier to review and more likely to get merged. Make sure the PR does only one thing, otherwise please split it.
73+
### Installation
7574

76-
Please make sure the following is done when submitting a pull request:
75+
1. Ensure you have [npm](https://www.npmjs.com/get-npm) installed.
76+
1. After cloning the repository, run `npm install` in the root of the repository.
77+
1. To start a development server, run `npm run dev`.
7778

78-
1. Fork [the repository](https://github.com/sveltejs/svelte) and create your branch from `master`.
79-
1. Describe your **test plan** in your pull request description. Make sure to test your changes.
80-
1. Make sure your code lints (`npm run lint`).
81-
1. Make sure your tests pass (`npm run test`).
79+
### Creating a branch
8280

83-
All pull requests should be opened against the `master` branch.
81+
Fork [the repository](https://github.com/sveltejs/svelte) and create your branch from `master`. If you've never sent a GitHub pull request before, you can learn how from [this free video series](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github).
8482

85-
#### Test plan
83+
### Testing
8684

8785
A good test plan has the exact commands you ran and their output, provides screenshots or videos if the pull request changes UI.
8886

@@ -110,6 +108,25 @@ Test samples are kept in `/test/xxx/samples` folder.
110108
1. Tests suites like `css`, `js`, `server-side-rendering` asserts that the generated output has to match the content in the `.expected` file. For example, in the `js` test suites, the generated js code is compared against the content in `expected.js`.
111109
1. To update the content of the `.expected` file, run the test with `--update` flag. (`npm run test --update`)
112110

111+
### Style guide
112+
113+
[Eslint](https://eslint.org) will catch most styling issues that may exist in your code. You can check the status of your code styling by simply running `npm run lint`.
114+
115+
#### Code conventions
116+
117+
- `snake_case` for internal variable names and methods.
118+
- `camelCase` for public variable names and methods.
119+
120+
### Sending your pull request
121+
122+
Please make sure the following is done when submitting a pull request:
123+
124+
1. Describe your **test plan** in your pull request description. Make sure to test your changes.
125+
1. Make sure your code lints (`npm run lint`).
126+
1. Make sure your tests pass (`npm run test`).
127+
128+
All pull requests should be opened against the `master` branch. Make sure the PR does only one thing, otherwise please split it.
129+
113130
#### Breaking changes
114131

115132
When adding a new breaking change, follow this template in your pull request:
@@ -123,19 +140,10 @@ When adding a new breaking change, follow this template in your pull request:
123140
- **Severity (number of people affected x effort)**:
124141
```
125142

126-
### What happens next?
127-
128-
The core Svelte team will be monitoring for pull requests. Do help us by making your pull request easy to review by following the guidelines above.
129-
130-
## Style guide
131-
132-
[Eslint](https://eslint.org) will catch most styling issues that may exist in your code. You can check the status of your code styling by simply running `npm run lint`.
133-
134-
### Code conventions
135-
136-
- `snake_case` for internal variable names and methods.
137-
- `camelCase` for public variable names and methods.
138-
139143
## License
140144

141145
By contributing to Svelte, you agree that your contributions will be licensed under its [MIT license](https://github.com/sveltejs/svelte/blob/master/LICENSE).
146+
147+
## Questions
148+
149+
Feel free to ask in [#contributing](https://discord.com/channels/457912077277855764/750401468569354431) on [Discord](https://svelte.dev/chat) if you have questions about our process, how to proceed, etc.

README.md

+5
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,11 @@ Svelte is an MIT-licensed open source project with its ongoing development made
2020
Funds donated via Open Collective will be used for compensating expenses related to Svelte's development such as hosting costs. If sufficient donations are received, funds may also be used to support Svelte's development more directly.
2121

2222

23+
## Roadmap
24+
25+
You may view [our roadmap](https://svelte.dev/roadmap) if you'd like to see what we're currently working on.
26+
27+
2328
## Development
2429

2530
Pull requests are encouraged and always welcome. [Pick an issue](https://github.com/sveltejs/svelte/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) and help us out!

0 commit comments

Comments
 (0)