Skip to content

Conversation

hkershaw-brown
Copy link
Member

Description:

Improved contributors guide

  • More friendly tone
  • More concrete explanation of what you can do to contribute and how.
  • remove quick-start for developers because it is out-dated, also not sure developers should be quick starting.
  • removed separate requesting-features-reporting-bugs.rst since this is covered in contributors guide.

Fixes issue

fixes #813

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

Documentation changes needed?

  • My change requires a change to the documentation.
    • I have updated the documentation accordingly.

Tests

Build documentation locally

Checklist for merging

  • Updated changelog entry
  • Documentation updated
  • Update conf.py

Checklist for release

  • Merge into main
  • Create release from the main branch with appropriate tag
  • Delete feature-branch

Testing Datasets

  • Dataset needed for testing available upon request
  • Dataset download instructions included
  • No dataset needed

Copy link
Contributor

@mgharamti mgharamti left a comment

Choose a reason for hiding this comment

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

Looks good to me. I've added a few changes for clarity. Otherwise, I think this is also good to go.

@hkershaw-brown hkershaw-brown added the release! bundle with next release label Sep 17, 2025
hkershaw-brown and others added 2 commits September 17, 2025 10:09
* More friendly tone
* More concrete explanation of what you can do to contribute and how.
* remove quick-start for developers because it is out-dated.

fixes #813
- Acknowledge diverse contributor types
- More details on bug reporting
- Encourage small and focused PRs
@hkershaw-brown hkershaw-brown merged commit 282d162 into main Sep 17, 2025
4 checks passed
@hkershaw-brown hkershaw-brown deleted the contributors-guide branch September 17, 2025 14:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

release! bundle with next release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation: contributors guide too vague

2 participants