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 guide #67

Open
cirocosta opened this issue Nov 6, 2019 · 4 comments
Open

Add contributing guide #67

cirocosta opened this issue Nov 6, 2019 · 4 comments

Comments

@cirocosta
Copy link
Member

Feature Request

What challenge are you facing?

There are certain steps that we need to go through before submitting a PR to this repository, e.g., ensuring that the erb templates were properly generated.

Currently, that's "tribal knowledge" spread across the team that is not openly communicated (and sometimes, forgotten by us 😅 )

A Modest Proposal

Have a CONTRIBUTING.md file, just like we do in concourse/concourse (see contributing.md).

@cirocosta
Copy link
Member Author

Oh, I just realized that @taylorsilva just had #65 in 🤔

@taylorsilva
Copy link
Member

This is a great idea if there are other things to capture. Running that script for the job templates is only one thing, but we also have the entire /dev directory that could go into a contributing.md, maybe?

What other items could go into a contributing.md?

@cirocosta
Copy link
Member Author

yeah, perhaps documenting the dev stuff would be good indeed, e.g., how we document how to build and run Concourse in the main contributinig one:

After making any changes, you can try them out by rebuilding and recreating the web and worker containers:
$ docker-compose up --build -d
[...]

(see https://github.com/concourse/concourse/blob/master/CONTRIBUTING.md#rebuilding-to-test-your-changes)

@cirocosta
Copy link
Member Author

oh, something else:

giving some guidance on adding things like example:, descriptions, not setting defaults, etc would be pretty nice

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

No branches or pull requests

2 participants