search

codebuddies / backend

CodeBuddies back-end
https://codebuddies.org
GNU General Public License v3.0
20 stars 25 forks source link

Create instructions for new contributor expectations, requirements, environments, and setup. #3

Closed lpatmo closed 4 years ago

brylie commented 5 years ago

Some requirements may be missing, such as vine:

$ python manage.py migrate
...
ModuleNotFoundError: No module named 'vine'
brylie commented 5 years ago

It is not clear how to connect to the Postgres databse. What should the username and password be?

DATABASES = {
    "default": env.db("DATABASE_URL", default="postgres:///cbv3_django_prototype")
}
BethanyG commented 5 years ago

Linking #12 (DB Setup Instructions for new contributors) and #13 (ENV Vars for New contributors in Django) here, as they apply to new contributor setup.

brylie commented 4 years ago

Since so many issues arebeing consolidated into this issue, it is increasingly important that we add a description and checklist with all of the desirrd elements to add to the README. That will help ensure that nothing falls through the cracks. I.e. please don't close an isdue without bringing over the contextual information.

In general, though, it is OK to have multiple small, focused issues to break down tasks into smaller chunks.

brylie commented 4 years ago

Also note that you didn't close #12 & #13 when linking them to this issue. Please re-open #27, since it is fairly descriptive.

BethanyG commented 4 years ago

Yeah. Agreed. This whole chain is now a mess. I will open a meta-issue with a clear description, and re-link issues there and add a checklist.

brylie commented 4 years ago

K. We can also relax a bit on closing issues. There are less than 20 open issues for this project.

lpatmo commented 4 years ago

it is increasingly important that we add a description and checklist with all of the desirerd elements to add to the README.

Agreed -- I'm learning this too re: Jira tickets at work. We could adopt something like an acceptance criteria template. Will look into editing the issue templates next. Also, apologies for not writing a description on the original post here! Since this thread has gotten meta I'll close this and make sure another issue is clearly open re: setup instructions.

bengineerdavis commented 4 years ago

I would nominate this to be a reopened issue, so clarify how new contributions, and related issues. This comes specifically from doing setup. Centralizing this would allow people to work a bit more independently, and reduce maintainer load going forward, if this could be further clarified.