@@ -9,7 +9,21 @@ we will appreciate if you provide as much detail as possible to reproduce or
9understand the problem, but nevertheless you are encouraged to open an issue
9understand the problem, but nevertheless you are encouraged to open an issue
10for any problem that you may encounter.
10for any problem that you may encounter.
12+## Picking Issues to Work on
14+Beginners are encouraged to pick up issues that are marked `help wanted`. It is
15+a good idea to update the issue expressing your intent so that others do not
16+duplicate the effort and people with a background on the issue can help.
18+## Contributing A Change
20+If the feature makes significant changes to design, we encourage you to open an
21+issue as early as possible so that you do not have to redo much work because of
22+changes in design decisions. However, if you are confident, you can still go
23+ahead and take that risk as the maintainers are supposed to be reasonable
12−## Pull Requests (PR)
26+### Pull Requests (PR)
14Please feel free to [send a pull
28Please feel free to [send a pull
15request (PR)](https://github.com/composewell/streamly/pulls) whether it is a
29request (PR)](https://github.com/composewell/streamly/pulls) whether it is a
@@ -22,7 +36,7 @@ not able to complete the PR, you are still welcome to submit it, maintainers
22will try their best to actively contribute and pick up your change as long as
36will try their best to actively contribute and pick up your change as long as
23the change is approved.
37the change is approved.
25−## Pull Request (PR) Checklist
39+### Pull Request (PR) Checklist
27Here is a quick checklist for a PR, for details please see the next section:
41Here is a quick checklist for a PR, for details please see the next section:
@@ -43,20 +57,6 @@ Here is a quick checklist for a PR, for details please see the next section:
43 necessary.
57 necessary.
44* [Changelog](Changelog.md) is updated if needed
58* [Changelog](Changelog.md) is updated if needed
46−## Contributing A Change
48−If the feature makes significant changes to design, we encourage you to open an
49−issue as early as possible so that you do not have to redo much work because of
50−changes in design decisions. However, if you are confident, you can still go
51−ahead and take that risk as the maintainers are supposed to be reasonable
54−### Picking Issues to Work on
56−Beginners are encouraged to pick up issues that are marked `help wanted`. It is
57−a good idea to update the issue expressing your intent so that others do not
58−duplicate the effort and people with a background on the issue can help.
60### Structuring Pull Requests
60### Structuring Pull Requests
62__Lean PR:__ Please keep the reviewer in mind when sending pull
62__Lean PR:__ Please keep the reviewer in mind when sending pull