Skip to content

Commit 884d33a

Browse files
author
Gui ⚡️ Guilherme Ferreira
authored
chore: contrib guideline before opening a pr (#338)
1 parent de2024b commit 884d33a

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

CONTRIBUTING.md

+9-2
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,14 @@ Please note that this project is released with a [Contributor Code of Conduct][c
66

77
## Submitting a pull request
88

9+
### Before opening a Pull Request
10+
11+
We recommend [opening an issue](https://github.com/Farfetch/kafkaflow/issues) before a substantial Pull Request if there isn’t [already an issue](https://github.com/Farfetch/kafkaflow/issues) for what you’d like to contribute. This helps facilitate a discussion before deciding on an implementation approach.
12+
13+
For some changes, such as typo fixes, documentation enhancements, or broken links, it may be suitable to open a small Pull Request by itself.
14+
15+
### How to open a Pull Request
16+
917
1. Check the issues or open a new one
1018
2. Fork this repository
1119
3. Create your feature branch: `git checkout -b my-new-feature`
@@ -33,7 +41,6 @@ Run command `make init_broker`
3341

3442
Run command `make shutdown_broker`
3543

36-
3744
## Resources
3845

3946
- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
@@ -44,4 +51,4 @@ Run command `make shutdown_broker`
4451

4552
By sending us your contributions, you are agreeing that your contribution is made subject to the terms of our [Contributor Ownership Statement](https://github.com/Farfetch/.github/blob/master/COS.md)
4653

47-
[code-of-conduct]: CODE_OF_CONDUCT.md
54+
[code-of-conduct]: CODE_OF_CONDUCT.md

0 commit comments

Comments
 (0)