Skip to content

Commit f5df64b

Browse files
committed
chore: update contributing guidelines and pull request template for GolfMCP branding
1 parent 314185c commit f5df64b

File tree

2 files changed

+16
-40
lines changed

2 files changed

+16
-40
lines changed

.github/CONTRIBUTING.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!-- omit in toc -->
2-
# Contributing to authed
2+
# Contributing to GolfMCP
33

44
First off, thanks for taking the time to contribute! ❤️
55

@@ -29,20 +29,20 @@ All types of contributions are encouraged and valued. See the [Table of Contents
2929
## Code of Conduct
3030

3131
This project and everyone participating in it is governed by the
32-
[authed Code of Conduct](https://github.com/authed-dev/authed/blob/main/CODE_OF_CONDUCT.md).
32+
[GolfMCP Code of Conduct](https://github.com/golf-mcp/golf/blob/main/CODE_OF_CONDUCT.md).
3333
By participating, you are expected to uphold this code. Please report unacceptable behavior
34-
to <antoni@getauthed.dev>.
34+
to <antoni@golf.dev>.
3535

3636

3737
## I Have a Question
3838

39-
> If you want to ask a question, we assume that you have read the available [Documentation](https://docs.getauthed.dev).
39+
> If you want to ask a question, we assume that you have read the available [Documentation](https://docs.golf.dev).
4040
41-
Before you ask a question, it is best to search for existing [Issues](https://github.com/authed-dev/authed/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.
41+
Before you ask a question, it is best to search for existing [Issues](https://github.com/golf-mcp/golf/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.
4242

4343
If you then still feel the need to ask a question and need clarification, we recommend the following:
4444

45-
- Open an [Issue](https://github.com/authed-dev/authed/issues/new).
45+
- Open an [Issue](https://github.com/golf-mcp/golf/issues/new).
4646
- Provide as much context as you can about what you're running into.
4747
- Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant.
4848

@@ -76,8 +76,8 @@ Depending on how large the project is, you may want to outsource the questioning
7676
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.
7777

7878
- Make sure that you are using the latest version.
79-
- 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://docs.getauthed.dev). If you are looking for support, you might want to check [this section](#i-have-a-question)).
80-
- 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/authed-dev/authed/issues?q=label%3Abug).
79+
- 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://docs.golf.dev). If you are looking for support, you might want to check [this section](#i-have-a-question)).
80+
- 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/golf-mcp/golf/issues?q=label%3Abug).
8181
- Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
8282
- Collect information about the bug:
8383
- Stack trace (Traceback)
@@ -89,12 +89,12 @@ A good bug report shouldn't leave others needing to chase you up for more inform
8989
<!-- omit in toc -->
9090
#### How Do I Submit a Good Bug Report?
9191

92-
> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to <antoni@getauthed.dev>.
92+
> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to <antoni@golf.dev>.
9393
<!-- You may add a PGP key to allow the messages to be sent encrypted as well. -->
9494
9595
We use GitHub issues to track bugs and errors. If you run into an issue with the project:
9696

97-
- Open an [Issue](https://github.com/authed-dev/authed/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
97+
- Open an [Issue](https://github.com/golf-mcp/golf/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
9898
- Explain the behavior you would expect and the actual behavior.
9999
- Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
100100
- Provide the information you collected in the previous section.
@@ -110,26 +110,26 @@ Once it's filed:
110110

111111
### Suggesting Enhancements
112112

113-
This section guides you through submitting an enhancement suggestion for authed, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
113+
This section guides you through submitting an enhancement suggestion for golf, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
114114

115115
<!-- omit in toc -->
116116
#### Before Submitting an Enhancement
117117

118118
- Make sure that you are using the latest version.
119-
- Read the [documentation](https://docs.getauthed.dev) carefully and find out if the functionality is already covered, maybe by an individual configuration.
120-
- Perform a [search](https://github.com/authed-dev/authed/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.
119+
- Read the [documentation](https://docs.golf.dev) carefully and find out if the functionality is already covered, maybe by an individual configuration.
120+
- Perform a [search](https://github.com/golf-mcp/golf/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.
121121
- 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. If you're just targeting a minority of users, consider writing an add-on/plugin library.
122122

123123
<!-- omit in toc -->
124124
#### How Do I Submit a Good Enhancement Suggestion?
125125

126-
Enhancement suggestions are tracked as [GitHub issues](https://github.com/authed-dev/authed/issues).
126+
Enhancement suggestions are tracked as [GitHub issues](https://github.com/golf-mcp/golf/issues).
127127

128128
- Use a **clear and descriptive title** for the issue to identify the suggestion.
129129
- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
130130
- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you.
131131
- You may want to **include screenshots or screen recordings** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [LICEcap](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and the built-in [screen recorder in GNOME](https://help.gnome.org/users/gnome-help/stable/screen-shot-record.html.en) or [SimpleScreenRecorder](https://github.com/MaartenBaert/ssr) on Linux. <!-- this should only be included if the project has a GUI -->
132-
- **Explain why this enhancement would be useful** to most authed users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
132+
- **Explain why this enhancement would be useful** to most golf users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
133133

134134
<!-- You might want to create an issue template for enhancement suggestions that can be used as a guide and that defines the structure of the information to be included. If you do so, reference it here in the description. -->
135135

.github/pull_request_template.md

Lines changed: 1 addition & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -16,28 +16,4 @@ Please delete options that are not relevant.
1616
- [ ] Documentation update
1717
- [ ] Security enhancement
1818
- [ ] Performance improvement
19-
- [ ] Code refactoring (no functional changes)
20-
21-
## How Has This Been Tested?
22-
23-
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration.
24-
25-
## Checklist:
26-
27-
- [ ] My code follows the style guidelines of this project
28-
- [ ] I have performed a self-review of my own code
29-
- [ ] I have commented my code, particularly in hard-to-understand areas
30-
- [ ] My changes generate no new warnings
31-
- [ ] I have added tests that prove my fix is effective or that my feature works
32-
- [ ] Any dependent changes have been merged and published in downstream modules
33-
- [ ] I have updated version numbers as needed (if needed)
34-
35-
## Security Considerations:
36-
37-
- [ ] My changes do not introduce any new security vulnerabilities
38-
- [ ] I have considered the security implications of my changes
39-
40-
41-
## Additional Information:
42-
43-
Any additional information, configuration or data that might be necessary to reproduce the issue or use the feature.
19+
- [ ] Code refactoring (no functional changes)

0 commit comments

Comments
 (0)