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

Add CONTRIBUTING.md #810

Open
Tracked by #2128
batpad opened this issue Jul 9, 2020 · 4 comments
Open
Tracked by #2128

Add CONTRIBUTING.md #810

batpad opened this issue Jul 9, 2020 · 4 comments
Assignees

Comments

@batpad
Copy link
Collaborator

batpad commented Jul 9, 2020

Breaking out of conversation here: #806 (comment)

We should add more comprehensive developer documentation to the backend repository, as we have more people working on the code. This should cover code-style guidelines, setting up linters, writing tests.

There's a bit of clean-up that would ideally be done before this makes sense, to ensure the current code follows the guidelines.

@thenav56 @gulfaraz

@nanometrenat
Copy link
Contributor

@batpad is this ticket still relevant?

@thenav56
Copy link
Member

Hey @nanometrenat Thanks for the reminder :D. Yes, it is still relevant.
We were thinking of implementing checks using CI using tools like black. We will need to document those using CONTRIBUTING.md

Sample configs for future reference.

The changes will change most of the codebase, so we will need to make these changes after all PRs have been merged to avoid change conflicts.
cc: @udaynwa @szabozoltan69

@thenav56 thenav56 mentioned this issue May 5, 2024
3 tasks
@nanometrenat
Copy link
Contributor

nanometrenat commented Jun 26, 2024

Hi peeps! Is this still a thing? Not sure if some of the older PRs in this repo will ever be merged at this stage.

@thenav56
Copy link
Member

Hey @nanometrenat, Thanks for checking in

We've made some updates in PR #2128, which this depends on. We will start working on this soon.

Furthermore, we can close this one #811 now

cc: @samshara @udaynwa

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants