Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/AngeloStavrow/indigo.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAngelo Stavrow <contact@angelostavrow.com>2019-09-21 16:56:56 +0300
committerGitHub <noreply@github.com>2019-09-21 16:56:56 +0300
commit3f043a27d0a20ceccb0f477e60aa485dac6a48d9 (patch)
tree699cf0f483fdecfa7e7ec9b6461d14399468f372
parent37946bb40f82d3b9a964472d93575626f299382c (diff)
parent7006da574223c66fa0f4b7a7623258e8991d0a79 (diff)
Merge pull request #60 from AngeloStavrow/28_improve-contribution-process
Improve contribution process
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.md35
-rw-r--r--.github/ISSUE_TEMPLATE/feature_request.md17
-rw-r--r--CHANGELOG.md10
-rw-r--r--CONTRIBUTING.md17
-rw-r--r--PULL_REQUEST_TEMPLATE.md13
-rw-r--r--README.md2
6 files changed, 20 insertions, 74 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
deleted file mode 100644
index b735373..0000000
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ /dev/null
@@ -1,35 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-
----
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**To Reproduce**
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
-
-**Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
-
-**Smartphone (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
- - Version [e.g. 22]
-
-**Additional context**
-Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
deleted file mode 100644
index 066b2d9..0000000
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ /dev/null
@@ -1,17 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project
-
----
-
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
-
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
-
-**Additional context**
-Add any other context or screenshots about the feature request here.
diff --git a/CHANGELOG.md b/CHANGELOG.md
index c6e7243..a486583 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -5,6 +5,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
+### Changed
+- Updated **CONTRIBUTING.md** to reflect new contributions process per [#28](https://github.com/AngeloStavrow/indigo/issues/28)
+
+### Removed
+- GitHub issue and pull request templates removed from the repo per [#28](https://github.com/AngeloStavrow/indigo/issues/28)
+
+## [1.2.0]
### Added
- You can now import custom CSS from `<YOUR_HUGO_SITE>/static/css/custom.css` per [#48](https://github.com/AngeloStavrow/indigo/issues/48)
@@ -59,7 +66,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Added
- The first public release of the indigo theme for Hugo, along with related project documentation (including this changelog).
-[Unreleased]: https://github.com/AngeloStavrow/indigo/compare/v1.1.0...HEAD
+[Unreleased]: https://github.com/AngeloStavrow/indigo/compare/v1.2.0...HEAD
+[1.2.0]: https://github.com/AngeloStavrow/indigo/compare/v1.1.0...v1.2.0
[1.1.0]: https://github.com/AngeloStavrow/indigo/compare/v1.0.6...v1.1.0
[1.0.6]: https://github.com/AngeloStavrow/indigo/compare/v1.0.5...v1.0.6
[1.0.5]: https://github.com/AngeloStavrow/indigo/compare/v1.0.4...v1.0.5
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index bb0eded..fc977fa 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,15 +1,18 @@
# Contributing
-When contributing to this repository, please first discuss the change you wish
-to make via issue, email, or any other method with the owners of this repository
-before making a change.
+When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
-Please note we have a code of conduct; please follow it in all your interactions
-with the project. You can find it [here](https://github.com/AngeloStavrow/indigo/blob/master/CODE_OF_CONDUCT.md)
+Please note we have a code of conduct; please follow it in all your interactions with the project. You can find it [here](https://github.com/AngeloStavrow/indigo/blob/master/CODE_OF_CONDUCT.md)
+
+## Bug Reports and Feature Requests
+
+1. [Check GitHub](https://github.com/AngeloStavrow/indigo/issues/) for existing issues similar your report/request. If you find one, add any extra detail you might think is helpful. It's also helpful to just see how many folks are affected by the bug. That's it!
+2. If you don't find an existing report for the bug you've come across, add [a new issue](https://github.com/AngeloStavrow/indigo/issues/new) outlining steps to reproduce, the expected outcome, and the actual outcome. Thoughts on how to implement the fix are welcome!
+3. Project owners (right now, me) will triage these incoming reports/requests and label them appropriately. Everything will be added to the new [Theme Work kanban board](https://github.com/AngeloStavrow/indigo/projects/1).
## Pull Request Process
-1. Please start by [opening an issue](https://github.com/AngeloStavrow/indigo/issues/new) describing what you'd like to change. Remember to search first, to avoid having it closed as a duplicate.
+1. If one doesn't already exist, please start by [opening an issue](https://github.com/AngeloStavrow/indigo/issues/new) describing what you'd like to change. Remember to search first, to avoid having it closed as a duplicate.
2. Make the changes discussed. Ensure that the theme builds and continues to function as expected; you can also try building the [theme gallery to test further](https://github.com/gohugoio/hugoThemes/blob/master/README.md). Place high value on page-load speed and responsive design.
3. Update the README with any new site/page parameters as necessary. If you've added new dependencies, make sure to list them too.
-4. Open a pull request and include the issue you opened in step 1 as part of the PR. Changes will be tested and, when everything's good to go, will be merged in by the project principals. \ No newline at end of file
+4. Open a pull request and include the issue you opened in step 1 as part of the PR. Changes will be tested and, when everything's good to go, will be merged in by the project owners. \ No newline at end of file
diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md
deleted file mode 100644
index 761b8d4..0000000
--- a/PULL_REQUEST_TEMPLATE.md
+++ /dev/null
@@ -1,13 +0,0 @@
-**Related Issue**
-This PR's content was first discussed in issue #
-
-**Dependency Changes**
-If relevant, list any dependencies added, removed, or changed.
-
-**Testing**
-- [ ] Built and tested to work on a standalone Hugo site
-- [ ] Built and tested to work in the Hugo Theme Gallery demo site ([link](https://github.com/gohugoio/hugoThemes/blob/master/README.md))
-- [ ] Tested with browser's responsive-design tools
-
-**Additional context**
-Add any other context about the pull request here.
diff --git a/README.md b/README.md
index 8907618..5c002cf 100644
--- a/README.md
+++ b/README.md
@@ -58,7 +58,7 @@ A thorough writeup of the theme has been graciously written by @infominer33.
## Contributing
-Please read [CONTRIBUTING.md](https://github.com/AngeloStavrow/indigo/blob/master/CONTRIBUTING.md) for details on the code of conduct, and the process for submitting pull requests.
+Please read [CONTRIBUTING.md](https://github.com/AngeloStavrow/indigo/blob/master/CONTRIBUTING.md) for details on the code of conduct, and the process for submitting bug reports, feature requests, and having your changes merged into the project.
## Versioning