Skip to content

Commit 3e0630d

Browse files
committed
CONTRIBUTING.md - fix links
1 parent eaf2df8 commit 3e0630d

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

CONTRIBUTING.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ Thanks for taking the time to contribute!
1313

1414
> If you want to ask a question, we assume you have read the available [documentation](https://shmem4py.readthedocs.io/).
1515
16-
Before you ask a question, it is best to search for existing [Issues](/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. Please note that many questions regarding the programming model itself and suggestions for its enhancements may better belong to the [OpenSHMEM Community](http://openshmem.org/site/Community) rather than the shmem4py project, which is naturally constrained by the specification and underlying OpenSHMEM implementations.
16+
Before you ask a question, it is best to search for existing [Issues](https://github.com/mpi4py/shmem4py/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. Please note that many questions regarding the programming model itself and suggestions for its enhancements may better belong to the [OpenSHMEM Community](http://openshmem.org/site/Community) rather than the shmem4py project, which is naturally constrained by the specification and underlying OpenSHMEM implementations.
1717

18-
If you still feel the need to ask a question or clarification, we recommend opening a [Discussion (Q&A)](/discussions/new?category=q-a). Please remember to provide as much context as possible about what you're running into and report project and platform versions depending on what seems relevant.
18+
If you still feel the need to ask a question or clarification, we recommend opening a [Discussion (Q&A)](https://github.com/mpi4py/shmem4py/discussions/new?category=q-a). Please remember to provide as much context as possible about what you're running into and report project and platform versions depending on what seems relevant.
1919

2020
We will then take care of the issue as soon as possible.
2121

@@ -32,7 +32,7 @@ A good bug report shouldn't leave others needing to chase you for more informati
3232

3333
- Make sure that you are using the latest version.
3434
- 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://shmem4py.readthedocs.io/).
35-
- 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](issues?q=label%3Abug).
35+
- 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/mpi4py/shmem4py/issues).
3636
- Also, make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
3737
- Collect information about the bug:
3838
- Stack trace (Traceback)
@@ -46,7 +46,7 @@ A good bug report shouldn't leave others needing to chase you for more informati
4646

4747
We use GitHub issues to track bugs and errors. If you run into an issue with the project:
4848

49-
- Open an [Issue](/issues/new).
49+
- Open an [Issue](https://github.com/mpi4py/shmem4py/issues/new).
5050
- Explain the behavior you would expect and the actual behavior.
5151
- 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.
5252
- Provide the information you collected in the previous section.
@@ -60,14 +60,14 @@ This section guides you through submitting an enhancement suggestion for shmem4p
6060

6161
- Make sure that you are using the latest version.
6262
- Read the [documentation](https://shmem4py.readthedocs.io/) carefully and find out if the functionality is already covered, maybe by an individual configuration.
63-
- Perform a [search](/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.
63+
- Perform a [search](https://github.com/mpi4py/shmem4py/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.
6464
- 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.
6565
- Consider whether your suggestion applies to shmem4py or [OpenSHMEM](http://openshmem.org/).
6666

6767

6868
#### How Do I Submit a Good Enhancement Suggestion?
6969

70-
Enhancement suggestions are tracked as [GitHub issues](/issues).
70+
Enhancement suggestions are tracked as [GitHub issues](https://github.com/mpi4py/shmem4py/issues).
7171

7272
- Use a **clear and descriptive title** for the issue to identify the suggestion.
7373
- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.

0 commit comments

Comments
 (0)