Skip to content
This repository has been archived by the owner on Sep 4, 2024. It is now read-only.

Update contributing doc and project readme to contain more information about build, usage, and release process #318

Open
cjgrady opened this issue May 20, 2022 · 0 comments
Open

Update contributing doc and project readme to contain more information about build, usage, and release process #318

cjgrady opened this issue May 20, 2022 · 0 comments
Assignees
@cjgrady
Labels
documentation Improvements or additions to documentation enhancement New feature or request release Tasks related to releasing testing Tasks related to testing and needed tests. user Tasks related to users and user experience
Milestone
Version-3.2

Comments

@cjgrady
Copy link
Contributor

cjgrady commented May 20, 2022

The primary thrust should be updating the contributing doc to explain the process of adding to the repository, building, testing, documentation, etc.

Look at the following for some good examples fo what project readmes and contributing guides should look like:

https://github.com/matiassingers/awesome-readme

https://github.com/mntnr/awesome-contributing
@cjgrady cjgrady self-assigned this May 20, 2022
@cjgrady cjgrady added documentation Improvements or additions to documentation user Tasks related to users and user experience enhancement New feature or request testing Tasks related to testing and needed tests. release Tasks related to releasing labels May 20, 2022
@cjgrady cjgrady added this to the Version-3.2 milestone May 20, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@cjgrady cjgrady

Labels
documentation Improvements or additions to documentation enhancement New feature or request release Tasks related to releasing testing Tasks related to testing and needed tests. user Tasks related to users and user experience
Projects
None yet
Milestone
Version-3.2
Development

No branches or pull requests
1 participant
@cjgrady