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 disclaimer in README #1590

Merged
merged 5 commits into from
Oct 27, 2021
Merged

Remove disclaimer in README #1590

merged 5 commits into from
Oct 27, 2021

Conversation

willschlitzer
Copy link
Contributor

As discussed in #1576, the disclaimer about PyGMT undergoing rapid development and having breaking changes is getting out of date, as we have standards for deprecating features and a somewhat-regular release schedule. This pull requests removes the disclaimer from README.md, and moves the feedback request to the "About" section.

Reminders

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst.
  • Write detailed docstrings for all functions/methods.
  • If adding new functionality, add an example to docstrings or tutorials.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash commands are:

  • /format: automatically format and lint the code
  • /test-gmt-dev: run full tests on the latest GMT development version

@willschlitzer willschlitzer added the documentation Improvements or additions to documentation label Oct 23, 2021
@willschlitzer willschlitzer self-assigned this Oct 23, 2021
@willschlitzer willschlitzer added this to the 0.5.0 milestone Oct 23, 2021
@willschlitzer willschlitzer marked this pull request as ready for review October 25, 2021 09:51
Copy link
Member

@seisman seisman left a comment

Choose a reason for hiding this comment

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

I'm OK with the changes.

@seisman seisman added the final review call This PR requires final review and approval from a second reviewer label Oct 25, 2021
README.rst Outdated Show resolved Hide resolved
README.rst Show resolved Hide resolved
Copy link
Member

@weiji14 weiji14 left a comment

Choose a reason for hiding this comment

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

Just one more suggestion, otherwise all good!

doc/maintenance.md Outdated Show resolved Hide resolved
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Oct 27, 2021
@seisman seisman merged commit 30df670 into main Oct 27, 2021
@seisman seisman deleted the readme/disclaimer-update branch October 27, 2021 13:49
@maxrjones
Copy link
Member

Do you think we should tone down the announcement "This package is in the early stages of design and implementation." in the installing guide as well?

@willschlitzer
Copy link
Contributor Author

Do you think we should tone down the announcement "This package is in the early stages of design and implementation." in the installing guide as well?

I think that's a good idea. I'll open a pull request.

sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
* remove disclaimer; move feedback request to about section
* remove redundant mention of forum
* add semantic versioning to maintenance.md

Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants