Skip to content

Commit 2d6d17e

Browse files
authored
chore: Clean up CONTRIBUTING.md and fix Makefile lint-smart syntax error (#1233)
- Remove all FIXME annotations from CONTRIBUTING.md - Update Communication, Setup, Testing, and Coding style guidelines sections - Add references to existing documentation (README, CLAUDE.md, PR templates) - Fix Makefile:833 bash syntax error (extra fi statement in lint-smart target) - Fix all markdown linting errors in CONTRIBUTING.md: - Add top-level # CONTRIBUTING header - Add language specifiers to code blocks - Add proper blank lines around headings and lists Signed-off-by: Jonathan Springer <[email protected]>
1 parent 6c077dd commit 2d6d17e

File tree

2 files changed

+29
-21
lines changed

2 files changed

+29
-21
lines changed

CONTRIBUTING.md

Lines changed: 29 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
1+
# CONTRIBUTING
2+
13
## Contributing In General
4+
25
Our project welcomes external contributions. If you have an itch, please feel
36
free to scratch it.
47

5-
To contribute code or documentation, please submit a **FIXME** [pull request](https://github.com/ibm/mcp-context-forge/pulls).
8+
To contribute code or documentation, please submit a [pull request](https://github.com/ibm/mcp-context-forge/pulls).
69

710
A good way to familiarize yourself with the codebase and contribution process is
8-
to look for and tackle low-hanging fruit in the **FIXME** [issue tracker](https://github.com/ibm/mcp-context-forge/issues).
11+
to look for and tackle low-hanging fruit in the [issue tracker](https://github.com/ibm/mcp-context-forge/issues).
912
Before embarking on a more ambitious contribution, please quickly [get in touch](#communication) with us.
1013

1114
**Note: We appreciate your effort, and want to avoid a situation where a contribution
@@ -14,14 +17,14 @@ cannot be accepted at all!**
1417

1518
### Proposing new features
1619

17-
If you would like to implement a new feature, please **FIXME** [raise an issue](https://github.com/ibm/mcp-context-forge/issues)
20+
If you would like to implement a new feature, please [raise an issue](https://github.com/ibm/mcp-context-forge/issues)
1821
before sending a pull request so the feature can be discussed. This is to avoid
1922
you wasting your valuable time working on a feature that the project developers
2023
are not interested in accepting into the code base.
2124

2225
### Fixing bugs
2326

24-
If you would like to fix a bug, please **FIXME** [raise an issue](https://github.com/ibm/mcp-context-forge/issues) before sending a
27+
If you would like to fix a bug, please [raise an issue](https://github.com/ibm/mcp-context-forge/issues) before sending a
2528
pull request so it can be tracked.
2629

2730
### Merge approval
@@ -38,12 +41,9 @@ Each source file must include a license header for the Apache
3841
Software License 2.0. Using the SPDX format is the simplest approach.
3942
e.g.
4043

41-
```
42-
/*
43-
Copyright <holder> All Rights Reserved.
44-
45-
SPDX-License-Identifier: Apache-2.0
46-
*/
44+
```python
45+
# Copyright <holder> All Rights Reserved.
46+
# SPDX-License-Identifier: Apache-2.0
4747
```
4848

4949
We have tried to make it as easy as possible to make contributions. This
@@ -57,31 +57,41 @@ must include a sign-off statement in the commit message.
5757
Here is an example Signed-off-by line, which indicates that the
5858
submitter accepts the DCO:
5959

60-
```
60+
```text
6161
Signed-off-by: John Doe <[email protected]>
6262
```
6363

6464
You can include this automatically when you commit a change to your
6565
local git repository using the following command:
6666

67-
```
67+
```bash
6868
git commit -s
6969
```
7070

7171
## Communication
72-
**FIXME** Please feel free to connect with us on our [Slack channel](link).
72+
73+
Please feel free to connect with us through the [issue tracker](https://github.com/ibm/mcp-context-forge/issues).
7374

7475
## Setup
75-
**FIXME** Please add any special setup instructions for your project to help the developer
76-
become productive quickly.
76+
77+
For setup instructions, please see the [Quick Start sections](README.md#quick-start---pypi) in the README, or refer to the [Installation](README.md#installation) section for detailed instructions.
7778

7879
## Testing
79-
**FIXME** Please provide information that helps the developer test any changes they make
80-
before submitting.
80+
81+
Before submitting changes, run the test suite as outlined in the [Bug-fix PR template](.github/PULL_REQUEST_TEMPLATE/bug_fix.md):
82+
83+
1. `make lint` - passes all linters
84+
2. `make test` - all unit + integration tests green
85+
3. `make coverage` - ≥ 90%
8186

8287
## Coding style guidelines
83-
**FIXME** Optional, but recommended: please share any specific style guidelines you might
84-
have for your project.
88+
89+
- **Python >= 3.11** with type hints
90+
- **Formatting**: Black (line length 200), isort (profile=black)
91+
- **Linting**: Ruff, Pylint per `pyproject.toml`
92+
- **Naming**: `snake_case` functions, `PascalCase` classes, `UPPER_CASE` constants
93+
94+
See [CLAUDE.md](CLAUDE.md#code-style--standards) for complete coding standards.
8595

8696
### Python File Headers
8797

Makefile

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -830,8 +830,6 @@ lint-smart:
830830
fi ;; \
831831
esac
832832

833-
fi
834-
835833
## --------------------------------------------------------------------------- ##
836834
## Individual targets (alphabetical, updated to use TARGET)
837835
## --------------------------------------------------------------------------- ##

0 commit comments

Comments
 (0)