Skip to content

Remove Duplicate CONTRIBUTING.md and add CHANGELOG to docs#381

Merged
martinRenou merged 12 commits intogeojupyter:mainfrom
arjxn-py:duplicate-contributing
Jan 22, 2025
Merged

Remove Duplicate CONTRIBUTING.md and add CHANGELOG to docs#381
martinRenou merged 12 commits intogeojupyter:mainfrom
arjxn-py:duplicate-contributing

Conversation

@arjxn-py
Copy link
Member

@arjxn-py arjxn-py commented Jan 22, 2025

Description

Shall close #380

Checklist

  • PR has a descriptive title and content.
  • PR description contains references to any issues the PR resolves, e.g. Resolves #XXX.
  • PR has one of the labels: documentation, bug, enhancement, feature, maintenance
  • Checks are passing.
    Failing lint checks can be resolved with:
    • pre-commit run --all-files
    • jlpm run lint

📚 Documentation preview: https://jupytergis--381.org.readthedocs.build/en/381/
💡 JupyterLite preview: https://jupytergis--381.org.readthedocs.build/en/381/lite

@github-actions
Copy link
Contributor

Binder 👈 Launch a Binder on branch arjxn-py/jupytergis/duplicate-contributing

@arjxn-py arjxn-py force-pushed the duplicate-contributing branch from 0af72a0 to b72ad20 Compare January 22, 2025 09:32
@arjxn-py arjxn-py added the documentation Improvements or additions to documentation label Jan 22, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Jan 22, 2025

Integration tests report: appsharing.space

@github-actions
Copy link
Contributor

Integration tests report: appsharing.space

@arjxn-py arjxn-py marked this pull request as ready for review January 22, 2025 12:33
@arjxn-py arjxn-py force-pushed the duplicate-contributing branch from 47b1009 to 90153e4 Compare January 22, 2025 13:12
@arjxn-py arjxn-py requested a review from martinRenou January 22, 2025 14:00
@arjxn-py
Copy link
Member Author

@martinRenou martinRenou changed the title Remove Duplicate CONTRIBUTING.md Remove Duplicate CONTRIBUTING.md and add CHANGELOG to docs Jan 22, 2025
Copy link
Member

@martinRenou martinRenou left a comment

Choose a reason for hiding this comment

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

Thanks!!

@martinRenou martinRenou merged commit fdc2992 into geojupyter:main Jan 22, 2025
15 checks passed
Copy link
Member

Choose a reason for hiding this comment

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

Maybe this should be in the docs directory so we can use sphinx directives and plugins to render a richer user experience. Perhaps instead of including from the repo root into the docs, we should hyperlink from the repo root to the docs?

Copy link
Member Author

Choose a reason for hiding this comment

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

Sure, that sounds good to me.
Apologies as this may have been discussed a little more before going this way.

Copy link
Member

Choose a reason for hiding this comment

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

No sweat at all! We can't discuss everything in advance, and especially with the team being globally distributed, EAFP! ;)

@arjxn-py arjxn-py deleted the duplicate-contributing branch March 16, 2025 13:06
HaudinFlorence pushed a commit to HaudinFlorence/jupytergis that referenced this pull request Jan 28, 2026
…r#381)

* update contributing.md accordingly as contributing.rst

* try using myst-parser to parse md

* Install myst-parser via pip

* typo

* pin myst-parser

* try building RTD

* lint

* pass pre-commit

* fic CI

* Add changelog to docs too

* fix rtd build
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.

Duplication of CONTRIBUTING.md file

3 participants