cbartos/gpt-contextfiles
1
0
Fork 0
mirror of https://github.com/Iheuzio/gpt-contextfiles.git synced 2025-07-18 05:50:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update contribution guide, readme is documentation

Browse Source
This commit is contained in:
Christopher 2023-06-22 12:42:53 -04:00
parent fc7a69869f
commit 4e0531d1cb
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
CONTRIBUTING.md
View File

@ -34,7 +34,7 @@ to any of the maintainers.
## I Have a Question
> If you want to ask a question, we assume that you have read the available [Documentation]().
> If you want to ask a question, we assume that you have read the available [Documentation](https://github.com/Iheuzio/gpt-contextfiles/blob/main/README.md).
Before you ask a question, it is best to search for existing [Issues](https://github.com/Iheuzio/gpt-contextfiles//issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.
@ -58,7 +58,7 @@ Just remember to add the relevant tags and keep discussions specific to that cat
A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
- Make sure that you are using the latest version.
- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](). If you are looking for support, you might want to check [this section](#i-have-a-question)).
- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](https://github.com/Iheuzio/gpt-contextfiles/blob/main/README.md). If you are looking for support, you might want to check [this section](#i-have-a-question)).
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/Iheuzio/gpt-contextfiles/issues?q=label%3Abug).
- Collect information about the bug:
- Stack trace (Traceback)
@ -94,7 +94,7 @@ This section guides you through submitting an enhancement suggestion for gpt-con
#### Before Submitting an Enhancement
- Make sure that you are using the latest version.
- Read the [documentation]() carefully and find out if the functionality is already covered, maybe by an individual configuration.
- Read the [documentation](https://github.com/Iheuzio/gpt-contextfiles/blob/main/README.md) carefully and find out if the functionality is already covered, maybe by an individual configuration.
- Perform a [search](https://github.com/Iheuzio/gpt-contextfiles//issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset.