Skip to content

Conversation

@VeckoTheGecko
Copy link
Contributor

This PR implements changes making Parcels more accessible for open source contributions, as well as implements some changes making it clearer how to report bugs or get support for Parcels.

Changes:

  • Update contributing section of the documentation (update docs/contributing.md , add CONTRIBUTING.md directing to docs so that those coming through GitHub are aware).
  • Add list of contributors in the README with link to contributing docs (not via all-contributors, but via another project that pulls from the GitHub contributors list).
  • Update issue templates (including a new “bug report” template promoting reporting the version number and code use).
  • Add Q&A discussion template (with pre-installed code blocks).
  • Add .vscode to gitignore

The updated discussion/issue templates are visible on my fork

Closes #1611

@VeckoTheGecko VeckoTheGecko changed the title Contributing documentation, issue/discussion templates, and other changes Contributing documentation and issue/discussion templates changes Jul 31, 2024
Copy link
Member

@erikvansebille erikvansebille left a comment

Choose a reason for hiding this comment

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

Great work!

Comment on lines +37 to +42
<a href="https://github.com/oceanparcels/parcels/graphs/contributors">
<img src="https://contrib.rocks/image?repo=oceanparcels/parcels" />
</a>

**All contributions are welcome! See the [contributing page](https://docs.oceanparcels.org/en/latest/contributing.html) in our documentation to see how to get involved.**
Image made with [contrib.rocks](https://contrib.rocks).
Copy link
Member

Choose a reason for hiding this comment

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

This is great; love it!

@VeckoTheGecko VeckoTheGecko merged commit 8b646d7 into master Jul 31, 2024
@VeckoTheGecko VeckoTheGecko deleted the v/open-source branch July 31, 2024 14:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

parcels open source refresh

3 participants