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

Draft contribution guidelines #1

Open
smaida opened this issue Aug 28, 2021 · 2 comments
Open

Draft contribution guidelines #1

smaida opened this issue Aug 28, 2021 · 2 comments

Comments

@smaida
Copy link
Contributor

smaida commented Aug 28, 2021

@likeuntomurphy I've started a draft of default contribution guidelines for the FM org. We can write one document which will serve as the default for all projects under the FM org.
https://github.com/fostermadeco/.github/blob/main/.github/contributing.md

https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors

Screen Shot 2021-08-28 at 6 48 35 PM

@likeuntomurphy
Copy link

likeuntomurphy commented Aug 28, 2021

I was just working on the same, actually. One of the things I definitely want to include, even if it only applies to the Docker project, is that ansible-lint -p {ansible_dir} (ansible-lint -p ansible in the case of the docker repo) doesn’t return any errors or warnings. There are some additional rules I am trying to figure out how to enforce — such as only quoting yaml values that require quoting and using single quotes for outer quotes and double quotes for inner where necessary(this aligns with VS Code’s Ansible linter).

Then there is the Google Bash guidelines doc I mentioned here. This should apply to the helper script after being rendered from the template.

I wanted to throw these two tidbits out there, even though I’m currently unsure how that affects your plans for a global contributing guide.

@smaida
Copy link
Contributor Author

smaida commented Aug 29, 2021

@likeuntomurphy, I suggest that we use global contribution guidelines that can be superseded by project-specific guidelines as needed. The contribution guidelines for this repository would then include a reference back to the main guidelines and our broader standards documentation where necessary.

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