From 73a7cdb7fd930a1ee568e38cdee9aee472a120c9 Mon Sep 17 00:00:00 2001 From: Rebecca Lindsey Date: Fri, 14 Jul 2023 17:24:00 -0600 Subject: [PATCH 1/5] Add CONTRIBUTING.md --- CONTRIBUTING.md | 144 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 144 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..18fb0fe --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,144 @@ +# Contributing to Podium API Sample Contacts + +Please take a moment to review this document in order to make the contribution +process easy and effective for everyone involved! +Also make sure you read our [Code of Conduct](CODE_OF_CONDUCT.md) that outlines our commitment towards an open and welcoming environment. + +## Using the issue tracker + +Use the issues tracker for: + +- [Bug reports](#bug-reports) +- [Submitting pull requests](#pull-requests) + +We do our best to keep the issue tracker tidy and organized, making it useful +for everyone. For example, we classify open issues per perceived difficulty, +making it easier for developers to [contribute to Podium API Sample Contacts](#pull-requests). + +## Bug reports + +A bug is either a _demonstrable problem_ that is caused by the code in the repository, +or indicate missing, unclear, or misleading documentation. Good bug reports are extremely +helpful - thank you! + +Guidelines for bug reports: + +1. **Use the GitHub issue search** — check if the issue has already been + reported. + +2. **Check if the issue has been fixed** — try to reproduce it using the + `main` branch in the repository. + +3. **Isolate and report the problem** — ideally create a reduced test + case. + +Please try to be as detailed as possible in your report. Include your Node version, provide steps to +reproduce the issue, and describe the outcome you were expecting. All these details +will help developers fix any potential bugs! + +Example: + +> Short and descriptive example bug report title +> +> A summary of the issue and the environment in which it occurs. If suitable, +> include the steps required to reproduce the bug. +> +> 1. This is the first step +> 2. This is the second step +> 3. Further steps, etc. +> +> `` - a link to the reduced test case (e.g. a GitHub Gist) +> +> Any other information you want to share that is relevant to the issue being +> reported. This might include the lines of code that you have identified as +> causing the bug, and potential solutions (and your opinions on their +> merits). + +## Pull requests + +Good pull requests - patches, improvements, new features - are a fantastic +help. They should remain focused in scope and avoid containing unrelated +commits. + +**IMPORTANT**: By submitting a patch, you agree that your work will be +licensed under the license used by the project. + +If you have any large pull request in mind (e.g. implementing features, +refactoring code, etc), **please ask first** otherwise you risk spending +a lot of time working on something that the project's developers might +not want to merge into the project. + +Please adhere to the coding conventions in the project (indentation, +accurate comments, etc.) and don't forget to add your own tests and +documentation. When working with git, we recommend the following process +in order to craft an excellent pull request: + +1. [Fork](https://help.github.com/articles/fork-a-repo/) the project, clone your fork, + and configure the remotes: + + ```bash + # Clone your fork of the repo into the current directory + git clone https://github.com//podium-api-sample-contacts + + # Navigate to the newly cloned directory + cd podium_ex + + # Assign the original repo to a remote called "upstream" + git remote add upstream https://github.com/podium/podium-api-sample-contacts + ``` + +2. If you cloned a while ago, get the latest changes from upstream, and update your fork: + + ```bash + git checkout main + git pull upstream main + git push + ``` + +3. Create a new topic branch (off of `main`) to contain your feature, change, + or fix. + + **IMPORTANT**: Making changes in `main` is discouraged. You should always + keep your local `main` in sync with upstream `main` and make your + changes in topic branches. + + ```bash + git checkout -b + ``` + +4. Commit your changes in logical chunks. Keep your commit messages organized, + with a short description in the first line and more detailed information on + the following lines. Feel free to use Git's + [interactive rebase](https://help.github.com/articles/about-git-rebase/) + feature to tidy up your commits before making them public. + +5. Make sure all the tests are still passing. + + ```bash + npm test + ``` + +6. Push your topic branch up to your fork: + + ```bash + git push origin + ``` + +7. [Open a Pull Request](https://help.github.com/articles/about-pull-requests/) + with a clear title and description. + +8. If you haven't updated your pull request for a while, you should consider + rebasing on master and resolving any conflicts. + + **IMPORTANT**: _Never ever_ merge upstream `main` into your branches. You + should always `git rebase` on `main` to bring your changes up to date when + necessary. + + ```bash + git checkout master + git pull upstream master + git checkout + git rebase master + ``` + +Thank you for your contributions! From b6bfe86069aebef4825afdeef07010a722456205 Mon Sep 17 00:00:00 2001 From: Rebecca Lindsey Date: Fri, 14 Jul 2023 17:25:02 -0600 Subject: [PATCH 2/5] Add CODE_OF_CONDUCT.md --- CODE_OF_CONDUCT.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 CODE_OF_CONDUCT.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..9546e57 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,22 @@ +# Contributor Code of Conduct + +As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities. + +We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality. + +Examples of unacceptable behavior by participants include: + +- The use of sexualized language or imagery +- Personal attacks +- Trolling or insulting/derogatory comments +- Public or private harassment +- Publishing other's private information, such as physical or electronic addresses, without explicit permission +- Other unethical or unprofessional conduct. + +Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project. Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team. + +This code of conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers. + +This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 1.2.0, available at [https://www.contributor-covenant.org/version/1/2/0/code-of-conduct/](https://www.contributor-covenant.org/version/1/2/0/code-of-conduct/) From 2e2c9b977089003e0dd17e6af11dec5f1c15e968 Mon Sep 17 00:00:00 2001 From: Rebecca Lindsey Date: Fri, 14 Jul 2023 17:39:13 -0600 Subject: [PATCH 3/5] Add CODEOWNERS --- .github/CODEOWNERS | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 .github/CODEOWNERS diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..cd734ab --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,3 @@ +# Podium API Sample Contacts is owned by Podium's Marketplace team. + +* @koobob \ No newline at end of file From eae1f81fc4bd4089b83091cffd5e99af1fcc712b Mon Sep 17 00:00:00 2001 From: Rebecca Lindsey Date: Fri, 14 Jul 2023 17:41:08 -0600 Subject: [PATCH 4/5] Genericize CODEOWNERS --- .github/CODEOWNERS | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index cd734ab..8d22fae 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1,3 +1 @@ -# Podium API Sample Contacts is owned by Podium's Marketplace team. - -* @koobob \ No newline at end of file +# Podium API Sample Contacts is owned by Podium's Marketplace team. \ No newline at end of file From 0cfdd9987f8158fcad7eb3d0d422eb9d8490e5da Mon Sep 17 00:00:00 2001 From: Rebecca Lindsey Date: Fri, 14 Jul 2023 18:17:16 -0600 Subject: [PATCH 5/5] Bump version --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 343e698..258fb75 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "podium-api-sample-contacts", - "version": "1.1.0", + "version": "1.1.1", "description": "A Podium demo app for CRUD contacts", "main": "index.js", "scripts": {