Added contribution section in Readme #2643
Conversation
Signed-off-by: Ayush Gupta <guptaayush9040@gmail.com>
| -------- | ||
| We welcome Contributions, updates, [discrepancy reports](https://github.com/theupdateframework/python-tuf/issues) and [pull requests](https://github.com/theupdateframework/python-tuf/pulls) are welcome. This project thrives on community collaboration. Contributors are expected to adhere to our [Code of Conduct](https://github.com/theupdateframework/python-tuf/blob/develop/docs/CODE-OF-CONDUCT.md). | ||
|
|
||
| Jump into our [Slack](https://communityinviter.com/apps/cloud-native/cncf)! Our projects are community-built and welcome collaboration. |
There was a problem hiding this comment.
Hi @Ayush9026 Hope you are doing well. IMO we don't need any contact details here (like Slack link). Just below that we have Contact section, which is the perfect place to define that and it is already there. WYT?
Also as i said here, Please wait for official maintainer's review what they think, before making any changes. I hope you understand. Thank you😊👍
There was a problem hiding this comment.
Hi @h4l0gen,
Any PR doesn't get merged without an official maintainer's review, and I always mention the issue in the PR. I raised this PR with the permission of @lukpueh sir. I just wanted to thank you for your feedback and didn’t make any changes based on it yet.
I understand the importance of patience in open source contributions. I have been contributing to different projects for some time, and I assure you that I follow the protocol of seeking maintainers' approval before raising any PR. Thank you for your understanding and support.
|
On a first read this feels rendundant since it mostly repeats links that already exist elsewhere in the same README. I don't mind re-organizing the README (I'm sure it could be better) but just adding the same links again in another paragraph feels bad for maintanability. |
|
I agree with @jku. @Ayush9026, I thought we were on the same page regarding the contents of this patch. See #2638 (comment) |
... just saw that this already happened in #2641. It think that's enough for now. |
Description of the changes being introduced by the pull request:
Added Contributing and Community section in Readme along with Developer documentation, including API reference and instructions for contributors
Fixes #2638