[Fixes - Documentation] update the CONTRIBUTING.md with Issues & Pull Requests sections

[sandramsc]

Description

This PR fixes #4932

Notes for Reviewers

There are 9 repositories connected to this issue where the same template added to the CONTRIBUTING.md of this layer5 repo will be added. This PR should only be considered for closure once all projects on the checklist have been updated (I will indicate this with a comment).

Signed commits

• Yes, I signed my commits.

[sandramsc]

Open discussion: Suggestions regarding the content added are welcome, please review and see if the outline provided for Issues & Pull Requests as well as Reviewing Pull Requests are in line with the organization's expectations. If this template is agreed upon then I will move forward with adding it to the remaining repos.

[goldfishdolphin]

Thanks @sandramsc for your time and contribution. I have some suggestions.

I would not recommend putting negative words like "rude, disrespectful or aggressive" on the contribution page. The content should be positive, friendly and appealing to the newcomers.
Can you please check the lowercase and uppercase of some words like "issue, pull request" also make first letter capital on each sentence after colon ":" ?
There is also a need of rephrasing content.
@Chadha93 and @leecalcote please confirm if we need png format of the images in integrations directory .

[sandramsc]

Thanks @sandramsc for your time and contribution. I have some suggestions.

I would not recommend putting negative words like "rude, disrespectful or aggressive" on the contribution page. The content should be positive, friendly and appealing to the newcomers. Can you please check the lowercase and uppercase of some words like "issue, pull request" and also make the first letter capital on each sentence after the colon ":" ? There is also a need to rephrase content. @Chadha93 and @leecalcote please confirm if we need png format of the images in the integrations directory.

Thanks for your feedback @goldfishdolphin . It's interesting to see your perspective on these words and the context a reader (contributor) might perceive them to be. From my perspective in this context, I see them as words describing a particular type of behaviour or tone (when it comes to writing).

I left these words in the template to echo the text in the existing Code of Conduct section of the CONTRIBUTING.md .

"Instances of abusive, harassing, or otherwise unacceptable behaviour may be reported by contacting community@layer5.io."

I can sum the mentioned words up as "unacceptable behaviour" as is in the quote above?

[goldfishdolphin]

@sandramsc are all these commits related to updating contributing.md file?

[sandramsc]

@sandramsc are all these commits related to updating contributing.md file?

@goldfishdolphin they arn't, I wasn't sure why they were pushed to this branch as I created, checked out, worked and pushed each task to its respective branch i.e (sandramsc:contributing/sandramsc/4932.. and sandramsc:screenshots/...), alas when I pushed to make a PR for this issue...the non-related commits from the later branch are showed here too.

Working on a fix to remove unrelated changes and study the initial cause.

Update:

even with the most recent push having, newly forked the repo, newly created the contributing/sandramsc/4932 to work on the CONTRIBUTING.md file, commits from another branch I'm currently making changes to have been pushed here.

Perhaps deleting the other branch first, then making a push to this branch will resolve the issue - will try that when updating the docs after receiving feedback from all reviewers.

[saurabh100ni]

let's discuss this item on today's website meeting,
please add this agenda in the docs if you would :) : https://docs.google.com/document/d/1XczAHXVe2FIWPqiF57ospJ43zw5cZQ7ui8mn39v5EvA/edit#heading=h.69qskjv558bk

[l5io]

🚀 Preview for commit fc911fc at: https://6511f686cdf0b61326f97bdd--layer5.netlify.app

[coder12git]

@sandramsc are all these commits related to updating contributing.md file?

@goldfishdolphin they arn't, I wasn't sure why they were pushed to this branch as I created, checked out, worked and pushed each task to its respective branch i.e (sandramsc:contributing/sandramsc/4932.. and sandramsc:screenshots/...), alas when I pushed to make a PR for this issue...the non-related commits from the later branch are showed here too.

Working on a fix to remove unrelated changes and study the initial cause.

Update:

even with the most recent push having, newly forked the repo, newly created the contributing/sandramsc/4932 to work on the CONTRIBUTING.md file, commits from another branch I'm currently making changes to have been pushed here.

Perhaps deleting the other branch first, then making a push to this branch will resolve the issue - will try that when updating the docs after receiving feedback from all reviewers.

ok @sandramsc i understood, why you are facing this, see the thing is if you are creating a new branch not going to master branch first before creating than in that caase you will get the changes reflected in pr of that branch too from where you have created a new branch, in your case this thing is happening.
Now, to fix this try to first go to master branch and then create a new branch for this issue, and also probably you have to delete this branch pr, bcoz this action is not reversable so even after deleting that branches you will get these issues. I hope this will help :)

[Rexford74]

I think this is very well put together. In absence of any major omissions, it think this should be merged. Well done @sandramsc

[leecalcote]

Thanks @sandramsc for your time and contribution. I have some suggestions.
I would not recommend putting negative words like "rude, disrespectful or aggressive" on the contribution page. The content should be positive, friendly and appealing to the newcomers. Can you please check the lowercase and uppercase of some words like "issue, pull request" also make first letter capital on each sentence after colon ":" ? There is also a need of rephrasing content. @Chadha93 and @leecalcote please confirm if we need png format of the images in integrations directory .

Thanks for your feedback @goldfishdolphin . It's interesting to see your perspective on these words and the context a reader (contributor) might perceive them to be. From my perspective in this context I see them as words describing a particular type of behaviour or tone (when it come to writing).

I left these words in the template to echo the text in the existing Code of Conduct section of the CONTRIBUTING.md .

"Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting community@layer5.io."

I can sum the mentioned words up as "unacceptable behaviour" as is in the quote above?

In context of "Pull Request Etiquette", alternatively, we might offer this sentiment's corollary, which could be: "exercise patience and empathy while offering critiques of the works of others."

[l5io]

🚀 Preview for commit 9b41463 at: https://6542b2fb6e1b3825f1450cd0--layer5.netlify.app

[l5io]

🚀 Preview for commit 155a1c4 at: https://6543df20aa65292ed991b619--layer5.netlify.app

[sandramsc]

@leecalcote Thanks for the feedback, moving forward with the suggested changes and converting this draft PR into an open one.

[l5io]

🚀 Preview for commit 1e0f7b1 at: https://65451ad4895d1100689fdb0b--layer5.netlify.app

[l5io]

🚀 Preview for commit c819d45 at: https://656d8d15745efd299973b887--layer5.netlify.app

[leecalcote]

Yay!

Finally, someone clicked the merge button!😅

[leecalcote]

I made a couple of modifications, the majority of which retained the original intent with only one or two augmenting the intent.

You exercised no small amount of patience on this, @sandramsc. Kudos to you for hangin' tough and seeing this through.