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

Determine new developer workflow #194

Closed
Tjzabel opened this issue Sep 26, 2019 · 5 comments · Fixed by #217

Comments

@Tjzabel
Copy link
Member

@Tjzabel Tjzabel commented Sep 26, 2019

Things we need to determine

  • How developers build and test TeleIRC
    • Should we create a custom IRC and Telegram group for testing purposes?
  • Should local deployment be done via Docker/Docker compose/minishift/bare metal?
@Tjzabel Tjzabel added this to the v2.0 milestone Sep 26, 2019
@Tjzabel Tjzabel added this to Backlog in TeleIRC development via automation Sep 26, 2019
@jwflory

This comment has been minimized.

Copy link
Member

@jwflory jwflory commented Nov 4, 2019

  • How developers build and test TeleIRC

Running a unit test suite should be enough as a minimum requirement for testing local changes.

  • Should we create a custom IRC and Telegram group for testing purposes?

No. The TeleIRC dev chat is intended to be used for experimental purposes. We can instruct someone how to test locally in an existing IRC channel and group if they want to verify their changes. If we want to test a PR, we should update the git branch of the TeleIRC dev chat for experimenting.

  • Should local deployment be done via Docker/Docker compose/minishift/bare metal?

Personally I think Docker Compose works well for local development. It has a low barrier to entry compared to some k8s/OpenShift tools. I think we should keep the bar low with something like Docker Compose once we are happy with our container image again (#193).

@Tjzabel

This comment has been minimized.

Copy link
Member Author

@Tjzabel Tjzabel commented Nov 4, 2019

I agree with the above. This is another issue I think would fit well in the docs/dev/ directory as a small subset of documentation.

@jwflory

This comment has been minimized.

Copy link
Member

@jwflory jwflory commented Nov 4, 2019

Do you mean like a "Project workflow" doc?

@Tjzabel

This comment has been minimized.

Copy link
Member Author

@Tjzabel Tjzabel commented Nov 4, 2019

I think since we already have the high level docs in the CONTRIBUTING.md, and the results of this issue (from what you said above) are roughly what we have documented, this issue may be safe to close.

I was thinking of a "project workflow" doc of some sort, but since we already have the contributing guidelines, I'm not sure it's necessary to have. What are your thoughts?

@jwflory

This comment has been minimized.

Copy link
Member

@jwflory jwflory commented Nov 4, 2019

@Tjzabel I think an underlying problem is we publish two different docs in two different places (Sphinx and CONTRIBUTING.md); consolidating our contributing guidelines into the same place as our actual docs should make the process of contributing (and what that looks like) clear. I could take this action item on to consolidate our docs.

jwflory added a commit to jwflory/teleirc that referenced this issue Nov 4, 2019
This commit moves the contributing guidelines into our documentation.
This helps give our contributing guidelines greater visibility to those
who want to get involved later.

Closes RITlug#194.

Signed-off-by: Justin W. Flory <git@jwf.io>
@jwflory jwflory closed this in #217 Nov 4, 2019
TeleIRC development automation moved this from Backlog to Done Nov 4, 2019
jwflory added a commit that referenced this issue Nov 4, 2019
This commit moves the contributing guidelines into our documentation.
This helps give our contributing guidelines greater visibility to those
who want to get involved later.

Closes #194.

Signed-off-by: Justin W. Flory <git@jwf.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
2 participants
You can’t perform that action at this time.