Skip to content

Commit fec704e

Browse files
authored
docs: changes to Contributing Guide (#1737) [skip ci]
1 parent c4cba69 commit fec704e

File tree

2 files changed

+18
-20
lines changed

2 files changed

+18
-20
lines changed

.github/CONTRIBUTING.md

Lines changed: 0 additions & 19 deletions
This file was deleted.

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,24 @@ Development of this product happens in the open on GitHub, and we are grateful t
198198
Please read our [Code of Conduct](../../../.github/blob/main/CODE_OF_CONDUCT.md) since we expect project participants to adhere to it.
199199

200200
### Contributing Guide
201-
Read our [contributing guide](.github/CONTRIBUTING.md) to learn about our development process, how to propose bug fixes and improvements, and how to build and test your changes.
201+
202+
Hiro welcomes all contributions to Hiro documentation. These contributions come in two forms: issues and pull requests.
203+
204+
#### Issues
205+
206+
Bugs, feature requests, and development-related questions should be directed to our [GitHub issues tracker](https://github.com/hirosystems/stacks-blockchain-api/issues/new).
207+
208+
If reporting a bug, try to provide as much context as possible and anything else that might be relevant to the describe the issue. If possible include a simple test case that we can use to reproduce the problem on our own.
209+
210+
For feature requests, please explain what you're trying to do, and how the requested feature would be a complement to the project.
211+
212+
The two most important pieces of information we need in order to properly evaluate an issue or a feature request is a clear description of the behavior being reported.
213+
214+
#### Pull requests
215+
216+
A pull request allows anyone to suggest changes to a repository on GitHub that can be easily reviewed by others. Once a pull request is opened, you can discuss and review the potential changes with collaborators and add follow-up commits before your changes are merged into the base branch.
217+
218+
Keep in mind that pull requests are not merged directly into the `master` branch. It must have `develop` as the base branch.
202219
203220
### Community
204221

0 commit comments

Comments
 (0)