search

guismicios / django_chaman

django chaman is a deployment wizard (chaman).
Apache License 2.0
0 stars 0 forks source link

The rules of the game #2

Open mkelly08 opened 5 years ago

mkelly08 commented 5 years ago

We need rules

It's important to have good rules from the beginning. We are committed to this project from some time and we want to create something that is and will continue to be important for us. We don't have experience doing open source projects. That's why I'm doing this issue. So we can discuss and propose the rules of the game.

Github setup

How should GitHub be setup?

  1. Should we let this repo be cloned and fork into a private one?
  2. Should we let anyone merge a pull request?
  3. How should a pull request be created?
  4. Who can close issues?
  5. What should be the Travis test? Should only be the unit test or should also include other thigs?

Issues

We need issues templates and Labels. It's good practice to have predefined issue templates that suits us. And good labels for easily issue management.

Milestone

What is a milestone and how should we use them? I think we should use a milestone to set very short objectives that involve a collection of defined issues.

Project

I set Tlaloc a project with the idea of keeping track for the first official realize. And use the project to track the releases.

Releases

How we need to setup GitHub to have the correct release.

SantiagoTorres commented 5 years ago

Should we let this repo be cloned and fork into a private one?

I'm not sure about this, so I can't make any calls

Should we let anyone merge a pull request?

No, I personally believe that master should be a protected branch and have a Team that can merge to master. Preferably, one or two core team members. A minimum number of reviews before it's merged should also be encouraged (e.g., at least two reviewers to approve before merging).

How should a pull request be created?

I'd say push to feature branches within this repository (no forking) for team members.

Who can close issues?

Same as who can merge.

What should be the Travis test? Should only be the unit test or should also include other things?

I think unit tests at a minimum. I wonder if you guys want to apply to get github actions going and probably try some headless selenium tests going too.

mkelly08 commented 5 years ago

I think unit tests at a minimum. I wonder if you guys want to apply to get GitHub actions going and probably try some headless selenium tests going too.

This project is not a web project. So I don't see how selenium would help us in this project. Also, I don't know much more about selenium than it helps you do test for web developments.

Shure the wizard should create Selenium ready test for the django apps that are going to be set.

I was thinking if Travis can make flake8 checks and more.

And yes we want to have GitHub actions any recommendation?

AldoCuriel commented 5 years ago

Tox can run Flake8 and Travis will run tox, or not?

But I have the doubt of what will be the starting tests you recommend @SantiagoTorres. We were thinking in trying the first pip package that download a code an install Django and have some flags for it.

How do we start the repo?