The contributing and developer guidelines in this repository assume a fairly high level of familiarity with this package's developers workflows and mostly serve as memory jogs for those developers. This makes it challenging for those who did not create the package to understand the development and contributing workflows.
What was the solution? (How)
Rework/refactor the CONTRIBUTING.md, DEVELOPMENT.md, GitHub issue templates, and pull request template with the goal of improving understandability to those not familiar with the code base, hatch-based workflows, GitHub pull request workflows, and our use of conventional commits. Also added a pytest marker to the job attachments cross-account tests just to make it easier to differentiate them from other integration tests.
What is the impact of this change?
The hope is that the development and contribution process should be much clearer for everyone.
How was this change tested?
N/A - docs. Though, I did make sure that the instructions for running the integration tests works.
Was this change documented?
It is documentation ;-)
Is this a breaking change?
Nope. No code.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
What was the problem/requirement? (What/Why)
The contributing and developer guidelines in this repository assume a fairly high level of familiarity with this package's developers workflows and mostly serve as memory jogs for those developers. This makes it challenging for those who did not create the package to understand the development and contributing workflows.
What was the solution? (How)
Rework/refactor the CONTRIBUTING.md, DEVELOPMENT.md, GitHub issue templates, and pull request template with the goal of improving understandability to those not familiar with the code base, hatch-based workflows, GitHub pull request workflows, and our use of conventional commits. Also added a pytest marker to the job attachments cross-account tests just to make it easier to differentiate them from other integration tests.
What is the impact of this change?
The hope is that the development and contribution process should be much clearer for everyone.
How was this change tested?
N/A - docs. Though, I did make sure that the instructions for running the integration tests works.
Was this change documented?
It is documentation ;-)
Is this a breaking change?
Nope. No code.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.