Skip to content

Documentation: Recommendations for automation authorship #123

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

Closed
1 task done
zackkrida opened this issue Feb 1, 2021 · 0 comments · Fixed by #124
Closed
1 task done

Documentation: Recommendations for automation authorship #123

zackkrida opened this issue Feb 1, 2021 · 0 comments · Fixed by #124
Assignees
Labels
💻 aspect: code Concerns the software code in the repository 🤖 aspect: dx Concerns developers' experience with the codebase 📄 aspect: text Concerns the textual material in the repository 🌟 goal: addition Addition of new feature 🟩 priority: low Low priority and doesn't need to be rushed

Comments

@zackkrida
Copy link
Member

Problem

For various ethical and technical reasons, we should establish best practices when writing scripts that automate code actions:

  • Committing to repositories
  • Replying to issues and pull requests
  • Automatically closing pull requests

We have a @cc-open-source-bot account that should be used as the author for all actions, workflows, and scripts. A few reasons to do this:

  • We don't need to rewrite scripts to change their author attribution when staff or community members leave
  • It makes it easy to audit our automations in the future, because all commits and messages will be associated with the single @cc-open-source-bot user account via the GitHub search, api, etc.

Description

Alternatives

Additional context

Implementation

  • I would be interested in implementing this feature.
@zackkrida zackkrida added 🟩 priority: low Low priority and doesn't need to be rushed 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work ✨ goal: improvement Improvement to an existing feature 💻 aspect: code Concerns the software code in the repository labels Feb 1, 2021
@zackkrida zackkrida self-assigned this Feb 1, 2021
@zackkrida zackkrida added 🌟 goal: addition Addition of new feature 📄 aspect: text Concerns the textual material in the repository 🤖 aspect: dx Concerns developers' experience with the codebase and removed ✨ goal: improvement Improvement to an existing feature 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work labels Feb 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💻 aspect: code Concerns the software code in the repository 🤖 aspect: dx Concerns developers' experience with the codebase 📄 aspect: text Concerns the textual material in the repository 🌟 goal: addition Addition of new feature 🟩 priority: low Low priority and doesn't need to be rushed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant