Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove gitlab references #1643

Merged
merged 4 commits into from
Jan 28, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .git-blame-ignore-revs
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
# Do not add new revision just because it feels unimportant
# - Add a link to the relevant issue/MR

# START https://gitlab.com/deltares/rtc-tools/-/merge_requests/458
# START https://github.com/Deltares/rtc-tools/issues/1536
2503c49901bc4a7a3dc86d46b234e8973ed2feb5
476aeb27d164cebe3781de7f9a40b04b839a5220
cf540b1ad8fc39909e6e05e7656901e26daefb62
Expand All @@ -27,4 +27,4 @@ cef7507e09c0f187ad209e949575a04b7204cbe9
8929d6eac903af87ef982566cb07f45369eedda1
ee870e42deda8974e482e96995c5c136a8cfe07c
7908178e50ababa32534d205d62d525049b60dc3
# END https://gitlab.com/deltares/rtc-tools/-/merge_requests/458
# END https://github.com/Deltares/rtc-tools/issues/1536
90 changes: 0 additions & 90 deletions .gitlab-ci.yml

This file was deleted.

19 changes: 12 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
There are many ways you can contribute to RTC-Tools, such as:

- **Reporting issues**: If you encounter any bugs, errors, or unexpected behavior while using RTC-Tools,
please report them on our [issue tracker](https://gitlab.com/deltares/rtc-tools/-/issues).
please report them on our [issue tracker](https://github.com/deltares/rtc-tools/issues).
Please follow the issue template and provide as much information as possible to help us reproduce and fix the issue.
- **Suggesting features**: If you have any ideas or suggestions for new features or improvements,
please share them on our [issue tracker](https://gitlab.com/deltares/rtc-tools/-/issues).
please share them on our [issue tracker](https://github.com/deltares/rtc-tools/issues).
Please use the appropriate category and tag for your topic and explain your motivation and use case clearly.
- **Submitting merge requests**: If you want to contribute code or documentation to RTC-Tools,
please fork the repository and create a merge request.
Expand All @@ -19,8 +19,8 @@ Please follow the [Sphinx syntax and style guide](https://www.sphinx-doc.org/en/
- **Reviewing merge requests**: If you are familiar with RTC-Tools and want to help us maintain the quality and consistency of the code and documentation,
please review the open merge requests and provide constructive feedback and suggestions.
- **Testing new releases**: If you want to help us test the new features and bug fixes before they are officially released,
please install the latest development version of RTC-Tools from the [Gitlab repository](https://gitlab.com/deltares/rtc-tools)
and report any issues or feedback on the [issue tracker](https://gitlab.com/deltares/rtc-tools/-/issues).
please install the latest development version of RTC-Tools from the [GitHub repository](https://github.com/deltares/rtc-tools)
and report any issues or feedback on the [issue tracker](https://github.com/deltares/rtc-tools/issues).

## Guidelines for creating issues
1. **Title**: Provide a concise and informative title. The title should summarize the problem.
Expand All @@ -31,14 +31,19 @@ please install the latest development version of RTC-Tools from the [Gitlab repo


## Guidelines for creating merge requests
1. **Identify or create issue**: Before making any changes, please open an issue following the guidelines above, or comment on an existing one in the [issue tracker](https://gitlab.com/deltares/rtc-tools/-/issues) to discuss your ideas with the maintainers.
This will help us avoid duplication of work and ensure that your contribution aligns with the goals of the project.
1. **Identify or create issue**: Before making any changes,
please open an issue following the guidelines above,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jbaayen: The new lines were used for readibility in the screen. There are not new white spaces

or comment on an existing one in the
[issue tracker](https://github.com/deltares/rtc-tools/issues)
to discuss your ideas with the maintainers.
This will help us avoid duplication of work
and ensure that your contribution aligns with the goals of the project.
2. **Branch**: Create a new branch for each merge request. The branch name should be descriptive and reflect the changes being made.
3. **Commit**: Please make your commits following the guidelines in the [Commits and Commit Messages](#commits-and-commit-messages) section below.
4. **Write tests**: If possible, write tests that cover your changes, and add them to the `tests` folder.
This will help ensure that your changes result in the desired behavior and that functionalities will not accidently break in the future.
5. **Documentation**: Please also update the documentation if necessary and add examples to the `examples` folder.
6. **Create merge request**: Mention the corresponding issue from the [issue tracker](https://gitlab.com/deltares/rtc-tools/-/issues).
6. **Create merge request**: Mention the corresponding issue from the [issue tracker](https://github.com/deltares/rtc-tools/issues).
Describe what changes you've made, why you've made them, and how they address the issue at hand.
7. **Code review**: Request code review from your peers. Address any comments or suggestions they might have.

Expand Down
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,12 @@ and


## License
RTC-Tools is licensed under the **[GNU Lesser General Public License v3.0](https://gitlab.com/deltares/rtc-tools/-/blob/guidelines_contributions/COPYING)**, and can be used free of charge. Deltares offers support packages for users who require assistance.
RTC-Tools is licensed under the **[GNU Lesser General Public License v3.0](COPYING)**,
and can be used free of charge. Deltares offers support packages for users who require assistance.


## Acknowledgment
If you use RTC-Tools in your work, please acknowledge it in any resulting publications. You can do this by citing RTC-Tools and providing a link to our [website](https://oss.deltares.nl/web/rtc-tools/home) or [Gitlab repository](https://gitlab.com/deltares/rtc-tools).
If you use RTC-Tools in your work, please acknowledge it in any resulting publications.
You can do this by citing RTC-Tools and providing a link to our
[website](https://oss.deltares.nl/web/rtc-tools/home) or
[GitHub repository](https://github.com/deltares/rtc-tools).
2 changes: 1 addition & 1 deletion doc/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ From Source
The latest RTC-Tools source can be downloaded using git::

# Get RTC-Tools source
git clone https://gitlab.com/deltares/rtc-tools.git
git clone https://github.com/deltares/rtc-tools.git

Then you can install this latest version as follows::

Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
description=DOCLINES[0],
long_description="\n".join(DOCLINES[2:]),
url="https://oss.deltares.nl/web/rtc-tools/home",
download_url="http://gitlab.com/deltares/rtc-tools/",
download_url="http://github.com/deltares/rtc-tools/",
classifiers=[_f for _f in CLASSIFIERS.split("\n") if _f],
platforms=["Windows", "Linux", "Mac OS-X", "Unix"],
packages=find_packages("src"),
Expand Down
4 changes: 1 addition & 3 deletions src/rtctools/rtctoolsapp.py
Original file line number Diff line number Diff line change
Expand Up @@ -102,9 +102,7 @@ def download_examples(*args):
version = rtctools.__version__
rtc_full_name = "rtc-tools-{}".format(version)
try:
url = "https://gitlab.com/deltares/rtc-tools/-/archive/{}/{}.zip".format(
version, rtc_full_name
)
url = "https://github.com/deltares/rtc-tools/zipball/{}".format(version)

opener = urllib.request.build_opener()
urllib.request.install_opener(opener)
Expand Down
Loading