fostermadeco / .github

0 stars 0 forks source link

Draft contribution guidelines #1

Open smaida opened 3 years ago

smaida commented 3 years ago

@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 commented 3 years ago

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 commented 3 years ago

@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.