From a622ec93243347e150120087d5431b994a0800fb Mon Sep 17 00:00:00 2001 From: Glenn Hermans Date: Fri, 4 Jun 2021 17:08:59 +0200 Subject: [PATCH 1/5] #4903 - Added contributing file --- .github/CONTRIBUTING.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 .github/CONTRIBUTING.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 000000000..9b67f83c2 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,25 @@ +## How to contribute to Bagisto + + +### **Bug Reporting** + +1. Verify that the bug was not already reported by searching on GitHub in the [Issues section](https://github.com/bagisto/bagisto/issues) +If you're unable to find an open issue, [open a new one.](https://github.com/bagisto/bagisto/issues/new) Please be sure to follow the [issue template](https://github.com/bagisto/bagisto/blob/master/.github/ISSUE_TEMPLATE/1_Bug_report.md) as much as possible. + +2. Verify that the bug you are reporting is a general issue and not specific to your individual setup. +For individual issues please use the [Community Forum](https:/forums.bagisto.com/). + +#### **Did you fix a bug?** + +1. To provide a code contribution for an issue you will need to set up your own fork of the [Bagisto repository](https://github.com/bagisto/bagisto). +Make your code changes, commit the changes and make a [Pull Request](https://help.github.com/articles/about-pull-requests/) to the [Bagisto repository](https://github.com/bagisto/bagisto). +2. Separate each fix into a new branch in your repository and name it with the issue ID e.g. issue-1234. +3. When committing to your individual branch, please try and use the following as your commit message +```Fixed #1234 - ``` +4. Please follow the pull request [template](https://github.com/bagisto/bagisto/blob/master/.github/PULL_REQUEST_TEMPLATE.md) as much as possible. + +### **Did you create a new feature or enhancement?** +1. To provide a code contribution for a new feature or enhancement a [feature request](https://github.com/bagisto/bagisto/issues/new?assignees=&labels=&template=2_Feature_request.md) report should be created in case it doesn't exist. +2. To contribute a feature to Bagisto, you must create a forked repository and set up your git and development environment. +3. Make sure your commit messages are relevant and descriptive. +4. Please follow the pull request [template](https://github.com/bagisto/bagisto/blob/master/.github/PULL_REQUEST_TEMPLATE.md) as much as possible. From 62d2eed08a538de4834c474608925ac54b05a7de Mon Sep 17 00:00:00 2001 From: Glenn Hermans Date: Fri, 4 Jun 2021 17:21:51 +0200 Subject: [PATCH 2/5] fixed #4903 --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 0ea462763..7c242aecd 100755 --- a/README.md +++ b/README.md @@ -141,6 +141,15 @@ Please don't disclose security vulnerabilities publicly. If you find any securit ### Miscellaneous +#### Contribute + +Bagisto is a community driven project, we appreciate every contribution from the community + +- If you found an issue that you think we should know about, or if you have a suggestion, please submit an issue. +- If you want to submit a solution or offer a new feature + +Please read our [contributing guide](https://github.com/bagisto-europe/bagisto/blob/master/.github/CONTRIBUTING.md) for more info. + #### Contributors This project is on [Open Collective](https://opencollective.com/bagisto) and it exists thanks to the people who contribute. From 0f9cc3371f87aa87f8875c18ca1792ccf90d3bdc Mon Sep 17 00:00:00 2001 From: Glenn Hermans Date: Fri, 4 Jun 2021 17:23:42 +0200 Subject: [PATCH 3/5] updated readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7c242aecd..44ce73dd9 100755 --- a/README.md +++ b/README.md @@ -146,7 +146,7 @@ Please don't disclose security vulnerabilities publicly. If you find any securit Bagisto is a community driven project, we appreciate every contribution from the community - If you found an issue that you think we should know about, or if you have a suggestion, please submit an issue. -- If you want to submit a solution or offer a new feature +- If you want to submit a solution or offer a new feature, please create a pull request. Please read our [contributing guide](https://github.com/bagisto-europe/bagisto/blob/master/.github/CONTRIBUTING.md) for more info. From f46b27dc940843db163caeb43a8835f882e62bce Mon Sep 17 00:00:00 2001 From: Glenn Hermans Date: Fri, 4 Jun 2021 17:33:23 +0200 Subject: [PATCH 4/5] Updated contributing file --- .github/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 9b67f83c2..19c8bf304 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -4,7 +4,7 @@ ### **Bug Reporting** 1. Verify that the bug was not already reported by searching on GitHub in the [Issues section](https://github.com/bagisto/bagisto/issues) -If you're unable to find an open issue, [open a new one.](https://github.com/bagisto/bagisto/issues/new) Please be sure to follow the [issue template](https://github.com/bagisto/bagisto/blob/master/.github/ISSUE_TEMPLATE/1_Bug_report.md) as much as possible. +If you're unable to find an open issue, [open a new one.](https://github.com/bagisto/bagisto/issues/new?assignees=&labels=&template=1_Bug_report.md). 2. Verify that the bug you are reporting is a general issue and not specific to your individual setup. For individual issues please use the [Community Forum](https:/forums.bagisto.com/). From ceddc6a88725693a36729a3a9dba748b8b4425f7 Mon Sep 17 00:00:00 2001 From: Glenn Hermans Date: Fri, 4 Jun 2021 17:33:55 +0200 Subject: [PATCH 5/5] fixed typo --- .github/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 19c8bf304..05a438e92 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -4,7 +4,7 @@ ### **Bug Reporting** 1. Verify that the bug was not already reported by searching on GitHub in the [Issues section](https://github.com/bagisto/bagisto/issues) -If you're unable to find an open issue, [open a new one.](https://github.com/bagisto/bagisto/issues/new?assignees=&labels=&template=1_Bug_report.md). +If you're unable to find an open issue, [open a new one](https://github.com/bagisto/bagisto/issues/new?assignees=&labels=&template=1_Bug_report.md). 2. Verify that the bug you are reporting is a general issue and not specific to your individual setup. For individual issues please use the [Community Forum](https:/forums.bagisto.com/).