From d6b06298edc9aa310d8679ad2487541798c72370 Mon Sep 17 00:00:00 2001 From: Alan Rynne Date: Mon, 5 Oct 2020 16:56:52 +0200 Subject: [PATCH 1/3] refactor: moved files to .github/ folder --- .../CODE_OF_CONDUCT.md | 26 ++++++------- CONTRIBUTING.md => .github/CONTRIBUTING.md | 0 .../ISSUE_TEMPLATE/ISSUE_TEMPLATE.md | 8 ++-- README.md | 37 ++++++++++--------- 4 files changed, 37 insertions(+), 34 deletions(-) rename CODE_OF_CONDUCT.md => .github/CODE_OF_CONDUCT.md (82%) rename CONTRIBUTING.md => .github/CONTRIBUTING.md (100%) rename ISSUE_TEMPLATE.md => .github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md (78%) diff --git a/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md similarity index 82% rename from CODE_OF_CONDUCT.md rename to .github/CODE_OF_CONDUCT.md index af11c1a..e8e6e22 100644 --- a/CODE_OF_CONDUCT.md +++ b/.github/CODE_OF_CONDUCT.md @@ -14,22 +14,22 @@ appearance, race, religion, or sexual identity and orientation. Examples of behavior that contributes to creating a positive environment include: -* Using welcoming and inclusive language -* Being respectful of differing viewpoints and experiences -* Gracefully accepting constructive criticism -* Focusing on what is best for the community -* Showing empathy towards other community members +- Using welcoming and inclusive language +- Being respectful of differing viewpoints and experiences +- Gracefully accepting constructive criticism +- Focusing on what is best for the community +- Showing empathy towards other community members Examples of unacceptable behavior by participants include: -* The use of sexualized language or imagery and unwelcome sexual attention or - advances -* Trolling, insulting/derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or electronic - address, without explicit permission -* Other conduct which could reasonably be considered inappropriate in a - professional setting +- The use of sexualized language or imagery and unwelcome sexual attention or + advances +- Trolling, insulting/derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or electronic + address, without explicit permission +- Other conduct which could reasonably be considered inappropriate in a + professional setting ## Our Responsibilities diff --git a/CONTRIBUTING.md b/.github/CONTRIBUTING.md similarity index 100% rename from CONTRIBUTING.md rename to .github/CONTRIBUTING.md diff --git a/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md similarity index 78% rename from ISSUE_TEMPLATE.md rename to .github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md index 715765d..9dcb418 100644 --- a/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md @@ -1,16 +1,16 @@ -If it's your first time here - or you forgot about them - make sure you read the [contribution guidelines](CONTRIBUTING.md), and then feel free to delete this line! +If it's your first time here - or you forgot about them - make sure you read the [contribution guidelines](CONTRIBUTING.md), and then feel free to delete this line! ### Expected vs. Actual Behavior -Describe the problem here. +Describe the problem here. ### Reproduction Steps & System Config (win, osx, web, etc.) -Let us know how we can reproduce this, and attach relevant files (if any). +Let us know how we can reproduce this, and attach relevant files (if any). ### Proposed Solution (if any) -Let us know what how you would solve this. +Let us know what how you would solve this. #### Optional: Affected Projects diff --git a/README.md b/README.md index 27efc6a..5c8e676 100644 --- a/README.md +++ b/README.md @@ -3,46 +3,49 @@ [![Twitter Follow](https://img.shields.io/twitter/follow/SpeckleSystems?style=social)](https://twitter.com/SpeckleSystems) [![Discourse users](https://img.shields.io/discourse/users?server=https%3A%2F%2Fdiscourse.speckle.works&style=flat-square)](https://discourse.speckle.works) [![Slack Invite](https://img.shields.io/badge/-slack-grey?style=flat-square&logo=slack)](https://speckle-works.slack.com/join/shared_invite/enQtNjY5Mzk2NTYxNTA4LTU4MWI5ZjdhMjFmMTIxZDIzOTAzMzRmMTZhY2QxMmM1ZjVmNzJmZGMzMDVlZmJjYWQxYWU0MWJkYmY3N2JjNGI) [![website](https://img.shields.io/badge/www-speckle.systems-royalblue?style=flat-square)](https://speckle.systems) - ## Introduction -This section should hold a quick intro on what this repo's about. For example: +This section should hold a quick intro on what this repo's about. For example: -This repo holds Speckle's: -- Default [Code of Conduct](CODE_OF_CONDUCT.md), -- Default [Contribution Guidelines](CONTRIBUTING.md), +This repo holds Speckle's: + +- Default [Code of Conduct](.github/CODE_OF_CONDUCT.md), +- Default [Contribution Guidelines](.github/CONTRIBUTING.md), - README template (you're reading it now), -- Default [Issue Template](ISSUE_TEMPLATE.md), +- Default [Issue Template](.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md), - OSS License (Apache 2.0) -Either copy paste the parts that are useful in existing repos, or use this as a base when creating a new repository. +Either copy paste the parts that are useful in existing repos, or use this as a base when creating a new repository. ## This Readme Template -Is rather straightforward. It includes several default sections and one section that requires special attention. +Is rather straightforward. It includes several default sections and one section that requires special attention. -Default sections: -- Badges: has several default social badges. Feel free to add more. +Default sections: + +- Badges: has several default social badges. Feel free to add more. - Developing & Debugging - needs filling in! -- Community - can be left as is. +- Community - can be left as is. -**License section**: If this is a pure OSS repo, like Core, remove everything after the first phrase. Otherwise, we need to plan ahead before releasing and make sure we're covered. +**License section**: If this is a pure OSS repo, like Core, remove everything after the first phrase. Otherwise, we need to plan ahead before releasing and make sure we're covered. ## Developing & Debugging -This doesn't make sense here, but in general, we should try to provide a small "how to" guide on local development and debugging, as it lowers the barrier to contributions. +This doesn't make sense here, but in general, we should try to provide a small "how to" guide on local development and debugging, as it lowers the barrier to contributions. ## Contributing Please make sure you read the [contribution guidelines](CONTRIBUTING.md) for an overview of the best practices we try to follow. -## Community +## Community + +The Speckle Community hangs out in two main places, usually: -The Speckle Community hangs out in two main places, usually: - on [the forum](https://discourse.speckle.works) -- on [the chat](https://speckle-works.slack.com/join/shared_invite/enQtNjY5Mzk2NTYxNTA4LTU4MWI5ZjdhMjFmMTIxZDIzOTAzMzRmMTZhY2QxMmM1ZjVmNzJmZGMzMDVlZmJjYWQxYWU0MWJkYmY3N2JjNGI) +- on [the chat](https://speckle-works.slack.com/join/shared_invite/enQtNjY5Mzk2NTYxNTA4LTU4MWI5ZjdhMjFmMTIxZDIzOTAzMzRmMTZhY2QxMmM1ZjVmNzJmZGMzMDVlZmJjYWQxYWU0MWJkYmY3N2JjNGI) -Do join and introduce yourself! +Do join and introduce yourself! ## License + Unless otherwise described, the code in this repository is licensed under the Apache-2.0 License. Please note that some modules, extensions or code herein might be otherwise licensed. This is indicated either in the root of the containing folder under a different license file, or in the respective file's header. If you have any questions, don't hesitate to get in touch with us via [email](mailto:hello@speckle.systems). From e2daad36e99ddc7ac257385294d0491d0de2f660 Mon Sep 17 00:00:00 2001 From: Alan Rynne Date: Mon, 5 Oct 2020 16:58:20 +0200 Subject: [PATCH 2/3] feat: added PR template Updated docs to reflect it. --- .github/PULL_REQUEST_TEMPLATE/PR_TEMPLATE.md | 25 ++++++++++++++++++++ README.md | 1 + 2 files changed, 26 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE/PR_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE/PR_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE/PR_TEMPLATE.md new file mode 100644 index 0000000..c1701e0 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/PR_TEMPLATE.md @@ -0,0 +1,25 @@ +Description of PR... + +## Changes + +- Item 1 +- Item 2 + +## Checklist + +- [ ] Unit tests +- [ ] Documentation + +## References + +(optional) + +Include **important** links regarding the implementation of this PR. +This usually includes and RFC or an aggregation of issues and/or individual conversations +that helped put this solution together. This helps ensure there is a good aggregation +of resources regarding the implementation. + +```text +Fixes #85, Fixes #22, Fixes username/repo#123 +Connects #123 +``` diff --git a/README.md b/README.md index 5c8e676..b1b434b 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,7 @@ This repo holds Speckle's: - Default [Contribution Guidelines](.github/CONTRIBUTING.md), - README template (you're reading it now), - Default [Issue Template](.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md), +- Default [Pull Request Template](.github/PULL_REQUEST_TEMPLATE/PR_TEMPLATE.md), - OSS License (Apache 2.0) Either copy paste the parts that are useful in existing repos, or use this as a base when creating a new repository. From 69cb2c79c7e8ec03c951472528607323c3d2d690 Mon Sep 17 00:00:00 2001 From: Alan Rynne Date: Mon, 5 Oct 2020 17:01:14 +0200 Subject: [PATCH 3/3] fix: updated old link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b1b434b..fae2457 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,7 @@ This doesn't make sense here, but in general, we should try to provide a small " ## Contributing -Please make sure you read the [contribution guidelines](CONTRIBUTING.md) for an overview of the best practices we try to follow. +Please make sure you read the [contribution guidelines](.github/CONTRIBUTING.md) for an overview of the best practices we try to follow. ## Community