Skip to content

Conversation

@Dor-bl
Copy link
Contributor

@Dor-bl Dor-bl commented Jan 17, 2026

This pull request adds a comprehensive "Contributing" section to the README.rst to help new contributors set up their development environment, run tests, follow code guidelines, generate documentation, and submit changes. The new instructions should make it easier for developers to get started and contribute effectively.

Contributor onboarding and workflow documentation:

  • Added step-by-step development setup instructions, including cloning the repository, creating a virtual environment, and installing dependencies.
  • Provided clear guidelines for running tests, generating coverage reports, and regenerating keyword documentation.
  • Outlined code style and contribution guidelines, including PEP 8 adherence, meaningful commit messages, and updating documentation/tests.
  • Detailed the process for submitting changes, from branching to opening a pull request and addressing CI/review feedback.## Implements

Copy link
Collaborator

@emanlove emanlove left a comment

Choose a reason for hiding this comment

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

Dor, thanks for adding this PR and sharing. It is good to see both the community need for this information as well as what you feel is important to add here. There has been some writing and editing of a contributors guide that we were going to publish here in the next couple weeks. It should have both the how to make a change but also what changes we are looking for and the current development philosophy. In addition we were hoping to reach out to some community members in the contribution effort.

It is also good to see your push for and concept on the developer guide. I wrote one, more of a release guide and really for myself to remember all the steps. But it is good to see what you feel is important.

Let me check in with the team to see where we are at with the contributors guide. I like this but thinking that if we push this today and then make the changes we have in place in anothr week it may be a bit confusing. If you can give me a couple days and then we will see where we go with this. Ok?

@emanlove emanlove added under review Acknowledge Acknowledge within Release Notes labels Jan 18, 2026
@emanlove emanlove modified the milestones: v3.2, v3.3 Jan 18, 2026
@Dor-bl
Copy link
Contributor Author

Dor-bl commented Jan 19, 2026

Hi @emanlove,
Sure, no problem. Go ahead and review it with the team.
If you have a more through guide, that will be great.

Thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Acknowledge Acknowledge within Release Notes under review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants