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

Update CONTRIBUTING.md #2159

Merged
merged 2 commits into from
Sep 2, 2022
Merged

Update CONTRIBUTING.md #2159

merged 2 commits into from
Sep 2, 2022

Conversation

inikolaidis
Copy link
Contributor

Purpose / why

Changes made according to collaborative doc here to make contributing guidelines clearer.

What changes were made?

  • Add all communication channels.
  • Creating "Github Issues" to replace "Report a Bug", "Documentation", "Request a new feature", "Use Cases" sections.
  • Creating "Github Pull Requests" to replace "Contribute code" section.

Verification

  • Linked LSAP process needs to be reviewed.
  • This version does not include a "Create a pull request" section. The instructions there had specific naming for branches and PRs - is this still practiced? Does creating a fork need to be covered here/on this page, or should there be another tutorial page for this?

Interested Parties

@rosiel @ysuarez

  • @Islandora/documentation
  • @Islandora/committers

Checklist

Pull-request Reviewer

Pull-request reviewer should ensure the following:

Person Merging

The person merging should ensure the following:

  • Does mkdocs still build successfully? (This is indicated by TravisCI passing. To test locally, and see warnings, see How To Build Documentation.)
  • If pages are renamed or removed, have all internal links to those pages been fixed?
  • If pages are added, have they been linked to or placed in the menu?
  • Did the PR receive at least one approval from a committer, and all issues raised have been addressed?

## Purpose / why

Changes made according to collaborative doc [here](https://docs.google.com/document/d/1h2KRHNtmyEf3hV5zeBF1O2AMx_WH1b0NWe3nRo5u3tk/edit?usp=sharing) to make contributing guidelines clearer.

## What changes were made?

- Add all community channels 
- creating "Github Issues" to replace "Report a Bug", "Documentation", "Request a new feature", "Use Cases" sections
- creating "Github Pull Requests" to replace "Contribute code" section

## Verification

* Linked LSAP process needs to be reviewed
* This version does not include a ["Create a pull request"](https://islandora.github.io/documentation/contributing/CONTRIBUTING/#create-a-pull-request) section. The instructions there had specific naming for branches and PRs - is this still practiced? Does creating a fork need to be covered here/on this page, or should there be another tutorial page for this?

## Interested Parties
@rosiel @ysuarez 

* @Islandora/documentation
* @Islandora/committers

## Checklist

### Pull-request Reviewer
Pull-request reviewer should ensure the following:

* [ ] Does this PR link to related [issues](https://github.com/Islandora/documentation/issues/)?
* [ ] Does the proposed documentation align with the [Islandora Documentation Style Guide](https://islandora.github.io/documentation/contributing/docs_style_guide/)?
* [ ] Are the changes accurate, useful, free of typos, etc?

### Person Merging
The person merging should ensure the following:

* [ ] Does mkdocs still build successfully? (This is indicated by TravisCI passing. To test locally, and see warnings, see [How To Build Documentation](https://islandora.github.io/documentation/technical-documentation/docs-build/).)
* [ ] If pages are renamed or removed, have all internal links to those pages been fixed?
* [ ] If pages are added, have they been linked to or placed in the menu?
* [ ] Did the PR receive at least one approval from a committer, and all issues raised have been addressed?
CONTRIBUTING.md Outdated Show resolved Hide resolved
@kstapelfeldt
Copy link
Member

+1 for removing 'create a PR' section. Can we merge this?

@seth-shaw-asu seth-shaw-asu merged commit 39039c5 into main Sep 2, 2022
@rosiel rosiel deleted the inikolaidis-patch-1 branch January 3, 2023 19:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants