Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
pombredanne opened this issue Apr 8, 2022 · 7 comments
Open

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

pombredanne opened this issue Apr 8, 2022 · 7 comments
Labels
documentation standards Org wide standards and proposals for the same

Comments

@pombredanne
Copy link
Member

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

@AyanSinhaMahapatra AyanSinhaMahapatra added the standards Org wide standards and proposals for the same label Apr 8, 2022
@mjherzog
Copy link
Member

mjherzog commented Apr 8, 2022

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

@pombredanne
Copy link
Member Author

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
Copy link
Member

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
Copy link

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
Copy link

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

@Chirag-01
Copy link

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

@BhaskarKulshrestha
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation standards Org wide standards and proposals for the same
Projects
None yet
Development

No branches or pull requests

7 participants