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

Define and apply some standards for the overall Arch-Update project maintenance #183

Closed
5 tasks done
Antiz96 opened this issue Jul 2, 2024 · 0 comments · Fixed by #191
Closed
5 tasks done

Define and apply some standards for the overall Arch-Update project maintenance #183

Antiz96 opened this issue Jul 2, 2024 · 0 comments · Fixed by #191
Labels
documentation Improvements or additions to documentation feature/request New feature or request
Milestone

Comments

@Antiz96
Copy link
Owner

Antiz96 commented Jul 2, 2024

I would like to define some standards for this project's maintenance to ease and/or structure multiple part of it (such as development, contributions, bug reports, change logging,...) from now on.

Here's what I'd like to implement:

  • Start using conventional commits
  • Create a CONTRIBUTING.md file containing clear guidelines about contributing and reporting bugs
  • Create templates for issues (and eventually pull requests as well?):
    - Bug report: Add a "Bug report:" prefix to the title, ask basic info (Distribution used, Arch-Update version, Arch-Update config file, etc...) & set the bug label
    - Feature request: Add a "Feature request:" prefix to the title & set the enhancement label
    - Other (General question/feedback): Nothing (keep it normal)
  • Create a CHANGELOG.md file to keep a proper changelog (outside of the GitHub release). git-cliff might be useful to maintain it.
  • Create a RELEASE.md file that sums up the required steps to create a new release
@Antiz96 Antiz96 added documentation Improvements or additions to documentation feature/request New feature or request labels Jul 2, 2024
@Antiz96 Antiz96 added this to the v2.2.0 milestone Jul 2, 2024
Antiz96 added a commit that referenced this issue Jul 2, 2024
Add templates for issues and pull requests to categorize each possible issue type properly and ask some relevant details to users in order to ease processing

Partially addresses #183
Antiz96 added a commit that referenced this issue Jul 2, 2024
Add templates for issues and pull requests to categorize each possible issue type properly and ask some relevant details to users in order to ease processing

Partially addresses #183
Antiz96 added a commit that referenced this issue Jul 3, 2024
Add a config for issue templates to disable blank issues and add a link to the contributing guidelines

Partially addresses #183
Antiz96 added a commit that referenced this issue Jul 3, 2024
Add a config for issue templates to disable blank issues and add a link to the contributing guidelines

Partially addresses #183
Antiz96 added a commit that referenced this issue Jul 3, 2024
* chore: Add contributing guidelines (CONTRIBUTING.md)

Add contributing guidelines (CONTRIBUTING.md) to the repo in order to define rules, standard and general guidelines for every future contributions and interactions in this project.

Addresses parts of #183

* style(CONTRIBUTING): Various wording improvements and typo fixes

* style(CONTRIBUTING): Remove trailing space
Antiz96 added a commit that referenced this issue Jul 3, 2024
Add templates for issues and pull requests to categorize each possible issue type properly and ask some relevant details to users in order to ease processing

Partially addresses #183
Antiz96 added a commit that referenced this issue Jul 3, 2024
Add a config for issue templates to disable blank issues and add a link to the contributing guidelines

Partially addresses #183
Antiz96 added a commit that referenced this issue Jul 3, 2024
* chore: Add contributing guidelines (CONTRIBUTING.md)

Add contributing guidelines (CONTRIBUTING.md) to the repo in order to define rules, standard and general guidelines for every future contributions and interactions in this project.

Addresses parts of #183

* style(CONTRIBUTING): Various wording improvements and typo fixes

* style(CONTRIBUTING): Remove trailing space
Antiz96 added a commit that referenced this issue Jul 3, 2024
Add a CHANGELOG.md file to keep a proper changelog (outside of the GitHub releases) and a git-cliff config to maintain it over time

Partially addresses #183
Antiz96 added a commit that referenced this issue Jul 3, 2024
Add a CHANGELOG.md file to keep a proper changelog (outside of the GitHub releases) and a git-cliff config to maintain it over time

Partially addresses #183
Antiz96 added a commit that referenced this issue Jul 3, 2024
Add a RELEASE.md file containing every steps required to create a new release

Closes #183
@Antiz96 Antiz96 closed this as completed in 1cb2427 Jul 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation feature/request New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant