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

Question: How to contribute correct? #2696

Open
bernd-mueller-el opened this issue Jan 15, 2025 · 1 comment
Open

Question: How to contribute correct? #2696

bernd-mueller-el opened this issue Jan 15, 2025 · 1 comment
Assignees
Labels

Comments

@bernd-mueller-el
Copy link

bernd-mueller-el commented Jan 15, 2025

Question

Can you please rework the contributing document in semaphore repository?
https://github.com/semaphoreui/semaphore/blob/develop/CONTRIBUTING.md
some examples

  • task compile
  • task compile:api:hooks
❯ task
task: Available tasks for this project:
* all:                       Install, test and build Semaphore for local architecture
* build:                     Build a full set of release binaries and packages
* deps:                      Install all build dependencies
* build:be:                  Build server binary
* build:debug:               Build DEBUG server binary
* build:fe:                  Build VueJS project
* deps:be:                   Vendor application dependencies
* deps:fe:                   Installs nodejs requirements
* deps:tools:                Installs required tools to build and publish
* docker:build:              Build all defined images for Semaphore
* docker:build:debug:        Build an DEBUG image for Semaphore server
* docker:build:runner:       Build an image for Semaphore runner
* docker:build:server:       Build an image for Semaphore server
* docker:deps:               Install docker testing dependencies
* docker:goss:               Check if container contains defined files
* docker:goss:runner:        Check if runner contains defined files
* docker:goss:server:        Check if server contains defined files
* docker:lint:               Lint all dockerfiles based on Hadolint
* docker:lint:runner:        Lint runner dockerfile based on Hadolint
* docker:lint:server:        Lint server dockerfile based on Hadolint
* docker:push:               Push the images to registry
* docker:test:               Test containers by building, running, testing and deleting them
* e2e:deps:                  Installs dredd dep for integration testing
* e2e:goodman:               Installs goodman which is required by dredd
* e2e:hooks:                 Compile required dredd hooks built
* e2e:test:                  Run end to end test for API with dredd
* e2e:test:local:            Run end to end test for API with dredd
* release:prod:              Create and publish a release
* release:test:              Create a local test release
* test:be:                   Run go code tests

Can you please also add examples for building packages to install and test in testing environments?
And how to make a pull request?
Thank you

Related to

Documentation

@fiftin
Copy link
Collaborator

fiftin commented Jan 15, 2025

Hi, thank you! It is outdated guide.

@fiftin fiftin self-assigned this Jan 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants