You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+6-6
Original file line number
Diff line number
Diff line change
@@ -13,9 +13,9 @@ Thanks for taking the time to contribute!
13
13
14
14
> If you want to ask a question, we assume you have read the available [documentation](https://shmem4py.readthedocs.io/).
15
15
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.
17
17
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.
19
19
20
20
We will then take care of the issue as soon as possible.
21
21
@@ -32,7 +32,7 @@ A good bug report shouldn't leave others needing to chase you for more informati
32
32
33
33
- Make sure that you are using the latest version.
34
34
- 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).
36
36
- Also, make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
37
37
- Collect information about the bug:
38
38
- Stack trace (Traceback)
@@ -46,7 +46,7 @@ A good bug report shouldn't leave others needing to chase you for more informati
46
46
47
47
We use GitHub issues to track bugs and errors. If you run into an issue with the project:
48
48
49
-
- Open an [Issue](/issues/new).
49
+
- Open an [Issue](https://github.com/mpi4py/shmem4py/issues/new).
50
50
- Explain the behavior you would expect and the actual behavior.
51
51
- 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.
52
52
- Provide the information you collected in the previous section.
@@ -60,14 +60,14 @@ This section guides you through submitting an enhancement suggestion for shmem4p
60
60
61
61
- Make sure that you are using the latest version.
62
62
- 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.
64
64
- 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.
65
65
- Consider whether your suggestion applies to shmem4py or [OpenSHMEM](http://openshmem.org/).
66
66
67
67
68
68
#### How Do I Submit a Good Enhancement Suggestion?
69
69
70
-
Enhancement suggestions are tracked as [GitHub issues](/issues).
70
+
Enhancement suggestions are tracked as [GitHub issues](https://github.com/mpi4py/shmem4py/issues).
71
71
72
72
- Use a **clear and descriptive title** for the issue to identify the suggestion.
73
73
- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
0 commit comments