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
The general process for addressing issues in DynAdjust is as follows.
49
49
50
-
1. Search the list of open issues in the [issue tracker](https://github.com/icsm-au/DynAdjust/issues) for any occurrence(s) of the issue you would like to address.
50
+
1. Search the list of open issues in the [issue tracker](https://github.com/geoscienceaustralia/DynAdjust/issues) for any occurrence(s) of the issue you would like to address.
51
51
1. If it is closely related to an existing open issue, please add a comment to the open issue rather than to create a new issue.
52
-
2. By default, the issue tracker displays open issues. Perhaps your issue relates to a defect previously marked as fixed, but remains unresolved. In this case, remove the `is:open` switch to search through [all issues](https://github.com/icsm-au/DynAdjust/issues?q=is%3Aissue). If you feel the issue persists, reopen the issue and provide comments (as described in the next step).
52
+
2. By default, the issue tracker displays open issues. Perhaps your issue relates to a defect previously marked as fixed, but remains unresolved. In this case, remove the `is:open` switch to search through [all issues](https://github.com/geoscienceaustralia/DynAdjust/issues?q=is%3Aissue). If you feel the issue persists, reopen the issue and provide comments (as described in the next step).
53
53
3. If the issue has not been raised before, continue to the next step.
54
54
2. Create a new issue, or reopen a closed issue.
55
-
1.**Defects**. If it is a defect, please describe how to reproduce it and, if possible, provide sample command line arguments and snippets of the output which demonstrate the defect. Please select an appropriate [label](https://github.com/icsm-au/DynAdjust/issues/labels) that characterises the issue.
55
+
1.**Defects**. If it is a defect, please describe how to reproduce it and, if possible, provide sample command line arguments and snippets of the output which demonstrate the defect. Please select an appropriate [label](https://github.com/geoscienceaustralia/DynAdjust/issues/labels) that characterises the issue.
56
56
2.**Enhancements**. If it is an enhancement, please provide the desired or expected behaviour not presently delivered by DynAdjust. Please cite any relevant technical documents (e.g. journal articles, reference texts or other publications) that may help the developers address the issue. Wherever possible, provide some test cases demonstrating expected behaviour.
57
57
3.**Compilation**. If your issue relates to compiler errors or warnings, please provide full details of the operating system and compiler version, and provide a snippet of the compiler error or warning produced.
58
58
4.**Feedback**. Perhaps you'd like to share your thoughts on how DynAdjust can be improved. In this context, you can:
59
59
- Contribute code you already have. If it is not ready for production, we'd be glad to hear from you and to help you get it ready for the next release.
60
60
- Propose a new function or suggest an alternative formula/algorithm.
61
-
- Contribute suggestions, corrections or updates to the [documentation](https://github.com/icsm-au/DynAdjust/blob/master/resources/DynAdjust%20Users%20Guide.pdf).
61
+
- Contribute suggestions, corrections or updates to the [documentation](https://github.com/geoscienceaustralia/DynAdjust/blob/master/resources/DynAdjust%20Users%20Guide.pdf).
62
62
- Share some sample data.
63
-
3. Create your own separate [fork](https://github.com/icsm-au/DynAdjust/network/members) of DynAdjust, or rebase your forked copy of DynAdjust to the latest version.
63
+
3. Create your own separate [fork](https://github.com/geoscienceaustralia/DynAdjust/network/members) of DynAdjust, or rebase your forked copy of DynAdjust to the latest version.
64
64
4. Prepare for a specific pull request and begin making your changes.
65
65
1. Ensure your changes relate to the discrete issue you're attempting to address. That is, don't try to solve or fix everything in the one change request.
66
-
2. For new DynAdjust features, create a new test script that tests your work and provides satisfactory [code coverage](https://coveralls.io/github/icsm-au/DynAdjust).
67
-
3. Make sure all tests pass using the supplied [`make_dynadjust_gcc.sh`](https://github.com/icsm-au/DynAdjust/blob/master/resources/make_dynadjust_gcc.sh) script. For instance, to build and test your changes, run the script as: `$ make_dynadjust_gcc.sh -c -a -n -t` This will build the code base without cloning a fresh copy, no user interaction, no installation and will execute all cmake tests. For more information, please refer to the [installation instructions](./INSTALLING.md).
66
+
2. For new DynAdjust features, create a new test script that tests your work and provides satisfactory [code coverage](https://coveralls.io/github/geoscienceaustralia/DynAdjust).
67
+
3. Make sure all tests pass using the supplied [`make_dynadjust_gcc.sh`](https://github.com/geoscienceaustralia/DynAdjust/blob/master/resources/make_dynadjust_gcc.sh) script. For instance, to build and test your changes, run the script as: `$ make_dynadjust_gcc.sh -c -a -n -t` This will build the code base without cloning a fresh copy, no user interaction, no installation and will execute all cmake tests. For more information, please refer to the [installation instructions](./INSTALLING.md).
68
68
4. Issue commits in logical packets of work, providing a clear message that describes what you're doing.
69
69
5. When all commits for your change request are complete, issue a pull request. Please provide concise, clear and simple descriptions of your changes (and don't forget to check your spelling!). If required, please assign a reviewer you feel would be best placed to review your changes.
70
70
5. People with sufficient permissions will review your changes and approve the request when they are satisfied. They may respond to you with questions or requests for further improvements.
71
71
72
72
### General discussion
73
73
74
-
Most discussions happen in the [issue tracker](https://github.com/icsm-au/DynAdjust/issues) or within pull requests. For general questions, please feel free to post to the repository's [discussion page](https://github.com/icsm-au/DynAdjust/discussions).
74
+
Most discussions happen in the [issue tracker](https://github.com/geoscienceaustralia/DynAdjust/issues) or within pull requests. For general questions, please feel free to post to the repository's [discussion page](https://github.com/geoscienceaustralia/DynAdjust/discussions).
75
75
76
76
We encourage the use of language that is objective, professional, respectful and considerate of the wide user/developer audience. DynAdjust's audience has a diverse background, including theoretical geodesists, GIS users, software developers and senior level experts. Not everyone will understand the level of detail being discussed, however, it should be simple enough for those with the relevant domain knowledge to understand and respond to. In all cases, we encourgage you to model positive communication behaviours.
77
77
78
78
### Private reports
79
79
80
-
Primarily, all issues, defects, enhancements and queries should be tracked publicly using the repository's [issue tracker](https://github.com/icsm-au/DynAdjust/issues). However, if you would like to submit a request or report privately (i.e. for cases when information should not be released publically), please direct your request ot report to [[email protected]](mailto:[email protected]).
80
+
Primarily, all issues, defects, enhancements and queries should be tracked publicly using the repository's [issue tracker](https://github.com/geoscienceaustralia/DynAdjust/issues). However, if you would like to submit a request or report privately (i.e. for cases when information should not be released publically), please direct your request ot report to [[email protected]](mailto:[email protected]).
DynAdjust implements a wide range of specialist geodetic and surveying algorithms and formulae. These have been sourced from journal articles, reference texts, published standards and other peer-reviewed publications. All functionality, algorithms and formulae have been documented in the [DynAdjust User's Guide](https://github.com/icsm-au/DynAdjust/blob/master/resources/DynAdjust%20Users%20Guide.pdf) and are appropriately cited with the full biblographic reference. When proposing a new feature that implements an undocumented algorithm or formula, please cite its full reference with your comments.
86
+
DynAdjust implements a wide range of specialist geodetic and surveying algorithms and formulae. These have been sourced from journal articles, reference texts, published standards and other peer-reviewed publications. All functionality, algorithms and formulae have been documented in the [DynAdjust User's Guide](https://github.com/geoscienceaustralia/DynAdjust/blob/master/resources/DynAdjust%20Users%20Guide.pdf) and are appropriately cited with the full biblographic reference. When proposing a new feature that implements an undocumented algorithm or formula, please cite its full reference with your comments.
87
87
88
88
Periodically, a DynAdjust Steering Committee meets to review the functionality of DynAdjust and to discuss potential enhancements. If you would like the Steering Committee to consider your thoughts on the future of DynAdjust, please submit your comments to [[email protected]](mailto:[email protected]).
89
89
@@ -107,10 +107,10 @@ Please consider writing code that can be implemented on the widest number of pla
107
107
108
108
The folder and file structure of the code base and supporting files is as follows:
109
109
110
-
- Code that is specific to a particular DynAdjust program is located in the [`dynadjust/dynadjust/`](https://github.com/icsm-au/DynAdjust/tree/master/dynadjust/dynadjust) folder. The projects named `dna...wrapper` are programs with user interfaces that can be executed from the command line. The projects without the `...wrapper` suffix are libraries that provide the specific functionality relating to that project.
111
-
- Code that is general and consumed by all projects is located in the [`dynadjust/include/`](https://github.com/icsm-au/DynAdjust/tree/master/dynadjust/include) folder.
112
-
- User documentation and build scripts are located in the [`resources/`](https://github.com/icsm-au/DynAdjust/tree/master/resources) folder.
113
-
- Sample data that you can use to test DynAdjust functionality is located in the [`sampleData/`](https://github.com/icsm-au/DynAdjust/tree/master/sampleData) folder.
110
+
- Code that is specific to a particular DynAdjust program is located in the [`dynadjust/dynadjust/`](https://github.com/geoscienceaustralia/DynAdjust/tree/master/dynadjust/dynadjust) folder. The projects named `dna...wrapper` are programs with user interfaces that can be executed from the command line. The projects without the `...wrapper` suffix are libraries that provide the specific functionality relating to that project.
111
+
- Code that is general and consumed by all projects is located in the [`dynadjust/include/`](https://github.com/geoscienceaustralia/DynAdjust/tree/master/dynadjust/include) folder.
112
+
- User documentation and build scripts are located in the [`resources/`](https://github.com/geoscienceaustralia/DynAdjust/tree/master/resources) folder.
113
+
- Sample data that you can use to test DynAdjust functionality is located in the [`sampleData/`](https://github.com/geoscienceaustralia/DynAdjust/tree/master/sampleData) folder.
114
114
115
115
### Best practice
116
116
@@ -129,27 +129,27 @@ For the most part, coding standards and principles for best practice adopted for
Although code changes can occur frequently, we endeavour to deliver new [releases](https://github.com/icsm-au/DynAdjust/releases) on a regular basis to help developers of other software packages and products that depend upon DynAdjust to plan accordingly. The currently adopted release schedule cadence is six months.
134
+
Although code changes can occur frequently, we endeavour to deliver new [releases](https://github.com/geoscienceaustralia/DynAdjust/releases) on a regular basis to help developers of other software packages and products that depend upon DynAdjust to plan accordingly. The currently adopted release schedule cadence is six months.
135
135
136
136
## Automated test suite
137
137
138
-
The file [`make_dynadjust_gcc.sh`](https://github.com/icsm-au/DynAdjust/blob/master/resources/make_dynadjust_gcc.sh) provides a way to build the code and run tests on local copies and on GitHub via continuous integration (CI) script.
138
+
The file [`make_dynadjust_gcc.sh`](https://github.com/geoscienceaustralia/DynAdjust/blob/master/resources/make_dynadjust_gcc.sh) provides a way to build the code and run tests on local copies and on GitHub via continuous integration (CI) script.
139
139
140
-
With every commit and pull request, the project is tested with a unit test suite managed by cmake (via [`CMakeLists.txt`](https://github.com/icsm-au/DynAdjust/blob/master/dynadjust/CMakeLists.txt)).
140
+
With every commit and pull request, the project is tested with a unit test suite managed by cmake (via [`CMakeLists.txt`](https://github.com/geoscienceaustralia/DynAdjust/blob/master/dynadjust/CMakeLists.txt)).
The DynAdjust repository uses an automated test suite managed by GitHub Actions and [Travis](https://travis-ci.org/github/icsm-au/DynAdjust) to ensure new or changed code is built and tested in an automated way. In this context, continuous integration (CI) has been set up to invoke builds for Linux using the script [`test_coverage.yml`](https://github.com/icsm-au/DynAdjust/actions/workflows/test_coverage.yml).
146
+
The DynAdjust repository uses an automated test suite managed by GitHub Actions and [Travis](https://travis-ci.org/github/geoscienceaustralia/DynAdjust) to ensure new or changed code is built and tested in an automated way. In this context, continuous integration (CI) has been set up to invoke builds for Linux using the script [`test_coverage.yml`](https://github.com/geoscienceaustralia/DynAdjust/actions/workflows/test_coverage.yml).
To ensure the test suite adequately covers the code base (as much as practically possible), code coverage analysis is run on every commit and pull request. The code coverage analysis tool used for DynAdjust is [coveralls.io](https://coveralls.io/github/icsm-au/DynAdjust). The developers are currently working on increasing the coverage provided by the cmake test suite (via [`CMakeLists.txt`](https://github.com/icsm-au/DynAdjust/blob/master/dynadjust/CMakeLists.txt)).
152
+
To ensure the test suite adequately covers the code base (as much as practically possible), code coverage analysis is run on every commit and pull request. The code coverage analysis tool used for DynAdjust is [coveralls.io](https://coveralls.io/github/geoscienceaustralia/DynAdjust). The developers are currently working on increasing the coverage provided by the cmake test suite (via [`CMakeLists.txt`](https://github.com/geoscienceaustralia/DynAdjust/blob/master/dynadjust/CMakeLists.txt)).
0 commit comments