Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add "Project best practices" page #1760

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Prev Previous commit
Next Next commit
Mention CI/CD
Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
frankharkins and Eric-Arellano committed Oct 10, 2024

Unverified

This commit is not signed, but one or more authors requires that any commit attributed to them is signed.
commit a7d02c71e9654a649f35aeaabe71a0a97ec4c85f
14 changes: 10 additions & 4 deletions docs/open-source/best-practices.mdx
Original file line number Diff line number Diff line change
@@ -39,10 +39,16 @@ Some key features are:

* **GitHub actions**
frankharkins marked this conversation as resolved.
Show resolved Hide resolved

Copy link
Collaborator

@Eric-Arellano Eric-Arellano Aug 30, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Software projects benefit from using continuous integration (CI) and continuous deployment (CD):
* [Continuous integration](https://www.atlassian.com/continuous-delivery/continuous-integration): automating the integration of changes to your code, including through the use of automated tests to ensure your changes do not break the project.
* [Continuous deployment](https://www.ibm.com/topics/continuous-deployment): automation of your deployment/release process. Often, continuous deployment can be semi-automated, such as requiring a human to initiate the deployment.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's a good idea to name-drop CI/CD so users can read about it more, but given the target audience, I think it's better as a "further reading" link at the end of the paragraph. Added in a7d02c7.

This feature runs scripts when certain events happen in your GitHub repo. For
example, you can run your [test suite](#test-your-project) when you push new
code or automatically [publish your package](#package-your-project) when
you tag a commit.
This feature runs scripts in the cloud when certain events happen in your
GitHub repo. For example, you can run your [test suite](#test-your-project)
when you push new code or automatically [publish your
package](#package-your-project) when you tag a commit.

Use GitHub actions for [continuous
integration](https://www.atlassian.com/continuous-delivery/continuous-integration)
(CI) and [continuous
deployment](https://www.ibm.com/topics/continuous-deployment) (CD) of your
project.

* **Security features**