bgin-global / igwg

Repository for Governance WG Documents
7 stars 1 forks source link

Implementing Code of Conduct into all of the repositories in the bgin-global project #1

Open shigeya opened 3 years ago

shigeya commented 3 years ago

Please refer to Adding a code of conduct to your project to do.

schwentker commented 3 years ago

We may want to update Code of Conduct with two items:

1) add website url e.g. near the top 2) change the phrase 'reception and dinners' to 'receptions and meals'

We may also want to add the Code of Conduct to the website documents area: https://bgin-global.org/docs

shigeya commented 3 years ago

Looks like I can assign to you once you commented:D

schwentker commented 3 years ago

Created pull request to add Repository for default files such as the Code of Conduct

Per the Github documentation: "Default files (in .github folder) will be used for any public repository owned by the account that does not contain its own file of that type."

shigeya commented 3 years ago

@schwentker I understand. For a system other than Windows, it is not a good idea to have a folder with a name starting with a dot since file names starting with a dot are hidden unless specified. May we change the repository name to something such as group-repository-template ?

schwentker commented 3 years ago

@shigeya the best functionality is achieved by putting the code of content in .github, the docs folder or in the repository root as follows:

GitHub will use and display default files for any public repository owned by the account that does not have its own file of that type in any of the following places:

For example, anyone who creates an issue or pull request in a public repository that does not have its own CONTRIBUTING file will see a link to the default CONTRIBUTING file.

https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file

How about we create a docs folder and put the Code of Conduct file in there?

shigeya commented 3 years ago

Thanks for the explanation. I didn't know about this. Let me read through the doc

shigeya commented 3 years ago

I understand, but the file name should be specific and in a specific format (refer to this section). I will follow-up in the PR, bgin-global/.github#1

schwentker commented 3 years ago

created pull request to merge CODE_OF_CONDUCT.md in .github folder

schwentker commented 3 years ago

is there anything else we need to do with this issue?

shigeya commented 3 years ago

Thanks for the effort. I haven't noticed your PR to change PDF to Markdown. Since you merged the markdown version, I think we're done.

On how to let people know your proposal. Please understand how GitHub notify people. In this case, there are several ways to do so:

  1. Override the branch in the PR https://github.com/bgin-global/.github/pull/1 to the one we intend, not delete and create a new PR (Since I commented, if you update the PR, I will get notification. If you delete + create, since you're the only owner, I will be not notified) you can do this by add more commits, then force push the branch using -f option (do this carefully..)
  2. Either mentioning the new PR in old PR, or refer the old PR in the new PR.
  3. Specifically ask somebody (like me) for review the updated PR before the merge.

I think, I prefer to do 1+3 unless the purpose of the PR doesn't change.

Anyway, It is easier to understand and tweak the change while they're in PR form (before merge)