From b72a1f9537a357ae2f9cc353dbebbe953fa3b95c Mon Sep 17 00:00:00 2001 From: Brady Planden Date: Thu, 11 Jul 2024 13:40:51 +0100 Subject: [PATCH 1/2] fix: convert stackoverflow links to inline discussion, add lychee exclude --- .github/workflows/lychee_links.yaml | 2 +- CONTRIBUTING.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/lychee_links.yaml b/.github/workflows/lychee_links.yaml index a5d181f94..7baabe959 100644 --- a/.github/workflows/lychee_links.yaml +++ b/.github/workflows/lychee_links.yaml @@ -41,7 +41,7 @@ jobs: --exclude "https://events.mapbox.com/*|https://events.mapbox.cn/*|https://api.mapbox.cn/*" --exclude "https://github.com/mikolalysenko/glsl-read-float/*" --exclude "https://fonts.openmaptiles.org/*" - --exclude "https://a.tile.openstreetmap.org/*" + --exclude "https://a.tile.openstreetmap.org/*|https://openstreetmap.org/*" --exclude "https://cdn.plot.ly/*" --exclude "https://doi.org/*" --exclude-path ./CHANGELOG.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 110debbb2..abebe3b0b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -64,7 +64,7 @@ You now have everything you need to start making changes! 6. PyBOP is developed in [Python](https://en.wikipedia.org/wiki/Python_(programming_language)), and makes heavy use of [NumPy](https://en.wikipedia.org/wiki/NumPy) (see also [NumPy for MatLab users](https://numpy.org/doc/stable/user/numpy-for-matlab-users.html) and [Python for R users](https://rebeccabarter.com/blog/2023-09-11-from_r_to_python)). 7. Make sure to follow our [coding style guidelines](#coding-style-guidelines). -8. Commit your changes to your branch with [useful, descriptive commit messages](https://chris.beams.io/posts/git-commit/): Remember these are publicly visible and should still make sense a few months ahead in time. While developing, you can keep using the GitHub issue you're working on as a place for discussion. [Refer to your commits](https://stackoverflow.com/questions/8910271/how-can-i-reference-a-commit-in-an-issue-comment-on-github) when discussing specific lines of code. +8. Commit your changes to your branch with [useful, descriptive commit messages](https://chris.beams.io/posts/git-commit/): Remember these are publicly visible and should still make sense a few months ahead in time. While developing, you can keep using the GitHub issue you're working on as a place for discussion. Refer to your commits when discussing specific lines of code. This is achieved by referencing the SHA-hash in the comment. An example of this looks like: `the commit 3e5c1e6 solved the issue...` 9. If you want to add a dependency on another library, or re-use code you found somewhere else, have a look at [these guidelines](#dependencies-and-reusing-code). ### C. Merging your changes with PyBOP @@ -105,7 +105,7 @@ Class names are CamelCase, and start with an upper case letter, for example `MyO While it's a bad idea for developers to "reinvent the wheel", it's important for users to get a _reasonably sized download and an easy install_. In addition, external libraries can sometimes cease to be supported, and when they contain bugs it might take a while before fixes become available as automatic downloads to PyBOP users. For these reasons, all dependencies in PyBOP should be thought about carefully and discussed on GitHub. -Direct inclusion of code from other packages is possible, as long as their license permits it and is compatible with ours, but again should be considered carefully and discussed in the group. Snippets from blogs and [stackoverflow](https://stackoverflow.com/) can often be included but must include attribution to the original by commenting with a link in the source code. +Direct inclusion of code from other packages is possible, as long as their license permits it and is compatible with ours, but again should be considered carefully and discussed in the group. Snippets from blogs and stackoverflow can often be included but must include attribution to the original by commenting with a link in the source code. ### Separating dependencies From 8862c0ae5e305dde248a508a931999aaea8ec53f Mon Sep 17 00:00:00 2001 From: Brady Planden Date: Thu, 11 Jul 2024 13:44:23 +0100 Subject: [PATCH 2/2] fix: second link exclusion --- .github/workflows/lychee_links.yaml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/lychee_links.yaml b/.github/workflows/lychee_links.yaml index 7baabe959..fa82a4c78 100644 --- a/.github/workflows/lychee_links.yaml +++ b/.github/workflows/lychee_links.yaml @@ -41,7 +41,8 @@ jobs: --exclude "https://events.mapbox.com/*|https://events.mapbox.cn/*|https://api.mapbox.cn/*" --exclude "https://github.com/mikolalysenko/glsl-read-float/*" --exclude "https://fonts.openmaptiles.org/*" - --exclude "https://a.tile.openstreetmap.org/*|https://openstreetmap.org/*" + --exclude "https://a.tile.openstreetmap.org/*" + --exclude "https://openstreetmap.org/*|https://www.openstreetmap.org/*" --exclude "https://cdn.plot.ly/*" --exclude "https://doi.org/*" --exclude-path ./CHANGELOG.md