Skip to content

Remove disclaimer in README #1590

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
Oct 27, 2021
Merged

Remove disclaimer in README #1590

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
330385c
remove disclaimer; move feedback request to about section
willschlitzer Oct 23, 2021
7147a3c
remove redundant mention of forum
willschlitzer Oct 26, 2021
d1581d5
add semantic versioning to maintenance.md
willschlitzer Oct 26, 2021
8102df8
Apply suggestions from code review
willschlitzer Oct 27, 2021
3d30950
Merge branch 'main' into readme/disclaimer-update
willschlitzer Oct 27, 2021
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
17 changes: 0 additions & 17 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,22 +50,6 @@ or visit the `PyGMT Gallery <https://www.pygmt.org/latest/gallery>`__.
:align: center
:target: https://www.youtube.com/watch?v=SSIGJEe0BIk


Disclaimer
----------

🚨 **This package is still undergoing rapid development.** 🚨

All of the API (functions/classes/interfaces) is subject to change until we reach v1.0.0
as per the `semantic versioning specification <https://semver.org/spec/v2.0.0.html>`__.
There may be non-backward compatible changes as we experiment with new design ideas and
implement new features. **This is not a finished product, use with caution.**

We welcome any feedback and ideas!
Let us know by submitting
`issues on GitHub <https://github.com/GenericMappingTools/pygmt/issues>`__
or by posting on our `Discourse forum <https://forum.generic-mapping-tools.org>`__.

About
-----

Expand All @@ -78,7 +62,6 @@ We rely heavily on new features that have been implemented in GMT 6.0. In partic
a new *modern execution mode* that greatly simplifies figure creation. **These features
are not available in the 5.4 version of GMT**.


Project goals
-------------

Expand Down
4 changes: 2 additions & 2 deletions doc/maintenance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,8 +177,8 @@ adjusted upward on every major and minor release, but never on a patch release.
## Backwards compatibility and deprecation policy

PyGMT is still undergoing rapid development. All of the API is subject to change
until the v1.0.0 release.

until the v1.0.0 release. Versioning in PyGMT is based on the
[semantic versioning specification](https://semver.org/spec/v2.0.0.html) (e.g. vMAJOR.MINOR.PATCH).
Basic policy for backwards compatibility:

- Any incompatible changes should go through the deprecation process below.
Expand Down