Skip to content

Commit

Permalink
replace refs to 'master' branch with main (#1795)
Browse files Browse the repository at this point in the history
the CONTRIBUTING docs, while they have a note on language, still
refer to a 'master' branch which doesn't exist in the repo. This
simply replaces 'master' with 'main' in CONTRIBUTING.md and
copies that file to .github/CONTRIBUTING.md too. There is one
more ref to 'master' in the main readme.md but it's for coveralls
and replacing 'main' in it doesn't fix the badge so I'm not sure
whether to change it
  • Loading branch information
phette23 authored May 9, 2022
1 parent ac98cfe commit 7e71825
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 34 deletions.
66 changes: 40 additions & 26 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,49 @@
# How to Contribute

We want your help to make Samvera great. There are a few guidelines
We want your help to make the Samvera community great. There are a few guidelines
that we need contributors to follow so that we can have a chance of
keeping on top of things.

## Code of Conduct

The Samvera Community is dedicated to providing a welcoming and positive
The Samvera Community is dedicated to providing a welcoming and positive
experience for all its members, whether they are at a formal gathering, in
a social setting, or taking part in activities online. Please see our
a social setting, or taking part in activities online. Please see our
[Code of Conduct](CODE_OF_CONDUCT.md) for more information.

## Samvera Community Intellectual Property Licensing and Ownership

All code contributors must have an Individual Contributor License Agreement
(iCLA) on file with the Samvera Steering Group. If the contributor works for
an institution, the institution must have a Corporate Contributor License
All code contributors must have an Individual Contributor License Agreement
(iCLA) on file with the Samvera Steering Group. If the contributor works for
an institution, the institution must have a Corporate Contributor License
Agreement (cCLA) on file.

[Samvera Community Intellectual Property Licensing and Ownership](https://samvera.atlassian.net/wiki/spaces/samvera/pages/405211651)

You should also add yourself to the `CONTRIBUTORS.md` file in the root of the project.

## Language

The language we use matters. Today, tomorrow, and for years to come
people will read the code we write. They will judge us for our
design, logic, and the words we use to describe the system.

Our words should be accessible. Favor descriptive words that give
meaning while avoiding reinforcing systemic inequities. For example,
in the Samvera community, we should favor using allowed\_list instead
of whitelist, denied\_list instead of blacklist, or source/copy
instead of master/slave.

We're going to get it wrong, but this is a call to keep working to
make it right. View our code and the words we choose as a chance to
have a conversation. A chance to grow an understanding of the systems
we develop as well as the systems in which we live.

See [“Blacklists” and “whitelists”: a salutary warning concerning the
prevalence of racist language in discussions of predatory
publishing](https://www.ncbi.nlm.nih.gov/pmc/articles/PMC6148600/) for
further details.

## Contribution Tasks

* Reporting Issues
Expand All @@ -34,7 +56,7 @@ You should also add yourself to the `CONTRIBUTORS.md` file in the root of the pr
### Reporting Issues

* Make sure you have a [GitHub account](https://github.com/signup/free)
* Submit a [Github issue](./issues) by:
* Submit a [Github issue](https://github.com/samvera/{{library}}/issues/) by:
* Clearly describing the issue
* Provide a descriptive summary
* Explain the expected behavior
Expand All @@ -45,13 +67,13 @@ You should also add yourself to the `CONTRIBUTORS.md` file in the root of the pr

* Fork the repository on GitHub
* Create a topic branch from where you want to base your work.
* This is usually the master branch.
* To quickly create a topic branch based on master; `git branch fix/master/my_contribution master`
* Then checkout the new branch with `git checkout fix/master/my_contribution`.
* Please avoid working directly on the `master` branch.
* This is usually the main branch.
* To quickly create a topic branch based on main; `git branch fix/main/my_contribution main`
* Then checkout the new branch with `git checkout fix/main/my_contribution`.
* Please avoid working directly on the `main` branch.
* You may find the [hub suite of commands](https://github.com/defunkt/hub) helpful
* Make sure you have added sufficient tests and documentation for your changes.
* Test functionality with RSpec; est features / UI with Capybara.
* Test functionality with RSpec; Test features / UI with Capybara.
* Run _all_ the tests to assure nothing else was accidentally broken.

### Documenting Code
Expand All @@ -63,15 +85,11 @@ You should also add yourself to the `CONTRIBUTORS.md` file in the root of the pr
* If you don't know exactly what a bit of code does, it is extra likely that it needs to be documented. Take a stab at it and ask for feedback in your pull request. You can use the 'blame' button on GitHub to identify the original developer of the code and @mention them in your comment.
* This work greatly increases the usability of the code base and supports the on-ramping of new committers.
* We will all be understanding of one another's time constraints in this area.
* YARD examples:
* [Hydra::Works::RemoveGenericFile](https://github.com/projecthydra-labs/hydra-works/blob/master/lib/hydra/works/services/generic_work/remove_generic_file.rb)
* [ActiveTriples::LocalName::Minter](https://github.com/ActiveTriples/active_triples-local_name/blob/master/lib/active_triples/local_name/minter.rb)
* [Getting started with YARD](http://www.rubydoc.info/gems/yard/file/docs/GettingStarted.md)

### Committing changes

* Make commits of logical units.
* Your commit should include a high level description of your work in HISTORY.textile
* Check for unnecessary whitespace with `git diff --check` before committing.
* Make sure your commit messages are [well formed](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
* If you created an issue, you can close it by including "Closes #issue" in your commit message. See [Github's blog post for more details](https://github.com/blog/1386-closing-issues-via-commit-messages)
Expand Down Expand Up @@ -112,18 +130,16 @@ You should also add yourself to the `CONTRIBUTORS.md` file in the root of the pr

### Submitting Changes

[Detailed Walkthrough of One Pull Request per Commit](http://ndlib.github.io/practices/one-commit-per-pull-request/)

* Read the article ["Using Pull Requests"](https://help.github.com/articles/using-pull-requests) on GitHub.
* Make sure your branch is up to date with its parent branch (i.e. master)
* `git checkout master`
* Make sure your branch is up to date with its parent branch (i.e. main)
* `git checkout main`
* `git pull --rebase`
* `git checkout <your-branch>`
* `git rebase master`
* `git rebase main`
* It is a good idea to run your tests again.
* If you've made more than one commit take a moment to consider whether squashing commits together would help improve their logical grouping.
* [Detailed Walkthrough of One Pull Request per Commit](http://ndlib.github.io/practices/one-commit-per-pull-request/)
* `git rebase --interactive master` ([See Github help](https://help.github.com/articles/interactive-rebase))
* `git rebase --interactive main` ([See Github help](https://help.github.com/articles/interactive-rebase))
* Squashing your branch's changes into one commit is "good form" and helps the person merging your request to see everything that is going on.
* Push your changes to a topic branch in your fork of the repository.
* Submit a pull request from your fork to the project.
Expand All @@ -134,9 +150,7 @@ We adopted [Github's Pull Request Review](https://help.github.com/articles/about
Common checks that may occur in our repositories:

1. Travis CI - where our automated tests are running
2. Hound CI - where we check for style violations
3. Approval Required - Github enforces at least one person approve a pull request. Also, all reviewers that have chimed in must approve.
4. CodeClimate - is our code remaining healthy (at least according to static code analysis)
2. Approval Required - Github enforces at least one person approve a pull request. Also, all reviewers that have chimed in must approve.

If one or more of the required checks failed (or are incomplete), the code should not be merged (and the UI will not allow it). If all of the checks have passed, then anyone on the project (including the pull request submitter) may merge the code.

Expand Down Expand Up @@ -164,6 +178,6 @@ If you are uncertain, bring other contributors into the conversation by assignin
# Additional Resources

* [General GitHub documentation](http://help.github.com/)
* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)
* [GitHub pull request documentation](https://help.github.com/articles/about-pull-requests/)
* [Pro Git](http://git-scm.com/book) is both a free and excellent book about Git.
* [A Git Config for Contributing](http://ndlib.github.io/practices/my-typical-per-project-git-config/)
16 changes: 8 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,10 +67,10 @@ further details.

* Fork the repository on GitHub
* Create a topic branch from where you want to base your work.
* This is usually the master branch.
* To quickly create a topic branch based on master; `git branch fix/master/my_contribution master`
* Then checkout the new branch with `git checkout fix/master/my_contribution`.
* Please avoid working directly on the `master` branch.
* This is usually the main branch.
* To quickly create a topic branch based on main; `git branch fix/main/my_contribution main`
* Then checkout the new branch with `git checkout fix/main/my_contribution`.
* Please avoid working directly on the `main` branch.
* You may find the [hub suite of commands](https://github.com/defunkt/hub) helpful
* Make sure you have added sufficient tests and documentation for your changes.
* Test functionality with RSpec; Test features / UI with Capybara.
Expand Down Expand Up @@ -131,15 +131,15 @@ further details.
### Submitting Changes

* Read the article ["Using Pull Requests"](https://help.github.com/articles/using-pull-requests) on GitHub.
* Make sure your branch is up to date with its parent branch (i.e. master)
* `git checkout master`
* Make sure your branch is up to date with its parent branch (i.e. main)
* `git checkout main`
* `git pull --rebase`
* `git checkout <your-branch>`
* `git rebase master`
* `git rebase main`
* It is a good idea to run your tests again.
* If you've made more than one commit take a moment to consider whether squashing commits together would help improve their logical grouping.
* [Detailed Walkthrough of One Pull Request per Commit](http://ndlib.github.io/practices/one-commit-per-pull-request/)
* `git rebase --interactive master` ([See Github help](https://help.github.com/articles/interactive-rebase))
* `git rebase --interactive main` ([See Github help](https://help.github.com/articles/interactive-rebase))
* Squashing your branch's changes into one commit is "good form" and helps the person merging your request to see everything that is going on.
* Push your changes to a topic branch in your fork of the repository.
* Submit a pull request from your fork to the project.
Expand Down

0 comments on commit 7e71825

Please sign in to comment.