diff --git a/Contributing.md b/Contributing.md index 047c4da..528ef41 100644 --- a/Contributing.md +++ b/Contributing.md @@ -4,7 +4,9 @@ DiscordChatExporter accepts contributions in the form of issues and pull request ## Creating issues -If you have a feature suggestion or want to report a bug, you are welcome to create an issue. When doing so, please follow these guidelines: +If you have a feature suggestion or want to report a bug, you are welcome to create an issue. + +Guidelines: - Avoid creating an issue if a similar one already exists. Look through existing open and closed issues first. - Keep your issue focused on one specific problem. If you have multiple suggestions or bug reports, please create separate issues for them. @@ -14,12 +16,15 @@ If you have a feature suggestion or want to report a bug, you are welcome to cre ## Creating pull requests -If you want to contribute code to the project, you can create a pull request. When doing so, please follow these guidelines: +If you want to contribute code to the project, you can do so by creating a pull request. + +Guidelines: -- Make sure that there is an existing issue that describes the problem solved by your pull request. This can be ignored for trivial changes. -- Try to keep the pull request focused and as small as possible. If you want to contribute multiple unrelated changes, please create separate pull requests for them. -- Follow the coding style and conventions already established by the project. When in doubt which style should be used in a particular case, ask in comments to your pull request. -- If you want to start a discussion regarding a specific part of the change, add review comments to your own code. This can be used to highlight something important or to seek input from others. +- Make sure that there is an existing issue that describes the problem solved by your pull request. If there isn't one, please create it first. +- Add a comment to the issue indicating that you want to submit a pull request for it. This can be a good opportunity to discuss possible solutions, finalize requirements, or ask questions. +- Keep your pull request focused and as small as possible. If you want to contribute multiple unrelated changes, please create separate pull requests for them. +- Follow the coding style and conventions already established by the project. When in doubt which style to use, ask in comments to your pull request. +- If you want to start a discussion regarding a specific change you made, add a review comment to your own code. This can be used to highlight something important or to seek input from others. ## Building the project locally