search

nexB / aboutcode

AboutCode project: tools and data to uncover things about code: the provenance, origin, license, and more (packages, security, quality, etc.) of FOSS code
http://www.aboutcode.org/
154 stars 93 forks source link

Document a way to make org-wide enhancement proposals #110

Open pombredanne opened 2 years ago

pombredanne commented 2 years ago

Description

We have things that are org-wide such as coding standards and more. We should have a simple way to document and adopt these. I suggest a process similar to Python PEPs, where we have a simple text document that goes through a PR and lands in this repo. These could be numbered ABC-XXXX

mjherzog commented 2 years ago

@pombredanne Where will we publish these proposals and the policies.

pombredanne commented 2 years ago

Where will we publish these proposals and the policies.

@mjherzog they would be published here in the git repo and what about pushing them on a RTD site too?

AyanSinhaMahapatra commented 2 years ago

what about pushing them on a RTD site too?

Yes, let's keep this in the RTD structure i.e. in docs/source/standards or something like that.

Abhijrathod commented 1 year ago

It is important to note that having a clear process, guidelines, and designated maintainers will help to ensure that the standards and guidelines are kept up-to-date and are being followed by the team. Additionally, having a clear numbering system for the documents will help to keep them organized and easy to reference.

ashutosh887 commented 1 year ago

I would like to work on this issue @Abhijrathod @pombredanne @mjherzog @AyanSinhaMahapatra @tdruez

Chirag-01 commented 1 year ago

If the issue is still open I will be happy to work on this issue

BhaskarKulshrestha commented 1 year ago

Is the issue still open ? I want to contribute for this issue .