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.
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 Code of Conduct for more information.
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.
You should also add yourself to the CONTRIBUTORS.md file in the root of the project.
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 for further details.
- Reporting Issues
- Making Changes
- Documenting Code
- Committing Changes
- Submitting Changes
- Reviewing and Merging Changes
- Make sure you have a GitHub account
- Submit a Github issue by:
- Clearly describing the issue
- Provide a descriptive summary
- Explain the expected behavior
- Explain the actual behavior
- Provide steps to reproduce the actual behavior
- Clearly describing the issue
- Fork the repository on GitHub
- Create a topic branch from where you want to base your work.
- This is usually the
mainbranch. - 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
mainbranch. - Please do not create a branch called
master. (See note below.) - You may find the hub suite of commands helpful
- This is usually the
- Make sure you have added sufficient tests and documentation for your changes.
- Test functionality with Jest.
- Run all the tests to assure nothing else was accidentally broken.
NOTE: This repository follows the Samvera Community Code of Conduct
and language recommendations.
Please do not create a branch called master for this repository or as part of
your pull request; the branch will either need to be removed or renamed before it can
be considered for inclusion in the code base and history of this repository.
- Some basic knowledge of AWS and CloudFormation
- Requires the SAM CLI and AWS CLI
- Building dependencies with the correct architecture on non-Linux systems requires Docker.
The following instructions require you to cd into the correct directory for whichever flavor of the template you're using - sam/standalone for the Lambda-only version, or sam/cloudfront for the CloudFront-enabled version.
For iterative development, you may want to use SAM Accelerate to keep the deployed stack in sync with local changes automatically.
The easiest way to deploy is using the SAM guided command:
sam build --use-container
sam deploy --guidedIf successful, make note of the Endpoint - IIIF Endpoint URL output. You'll need this to test the API.
To test the API, you'll need an identifier that exists in your source bucket. Make a request for that identifier with:
<myapiendpoint>/<myimageidentifier>/full/full/0/default.jpg
Replace <myapiendpoint> with the Endpoint output from the sam deploy command.
- Make commits of logical units.
- Check for unnecessary whitespace with
git diff --checkbefore committing. - Make sure your commit messages are well formed.
- 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
Present tense short summary (50 characters or less)
More detailed description, if necessary. It should be wrapped to 72
characters. Try to be as descriptive as you can, even if you think that
the commit content is obvious, it may not be obvious to others. You
should add such description also if it's already present in bug tracker,
it should not be necessary to visit a webpage to check the history.
Include Closes #<issue-number> when relevant.
Description can have multiple paragraphs and you can use code examples
inside, just indent it with 4 spaces:
function handler(event) {
if (notAuthorized) { // based on something in the event.request
return {
statusCode: 403,
statusDescription: 'Unauthorized'
};
};
return event.request;
}
You can also add bullet points:
- you can use dashes or asterisks
- also, try to indent next line of a point for readability, if it's too
long to fit in 72 characters
- Make sure you have added the necessary tests for your changes.
- Run all the tests to assure nothing else was accidentally broken.
- When you are ready to submit a pull request
- Read the article "Using Pull Requests" on GitHub.
- Make sure your branch is up to date with its parent branch (i.e. main)
git checkout maingit pull --rebasegit checkout <your-branch>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
git rebase --interactive main(See Github help)- 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.
We adopted Github's Pull Request Review for our repositories. Common checks that may occur in our repositories:
- CircleCI - where our automated tests are running
- Coveralls - code coverage reports and checks
eslint- where we check for style violations- Approval Required - Github enforces at least one person approve a pull request. Also, all reviewers that have chimed in must approve.
- CodeClimate - is our code remaining healthy (at least according to static code analysis)
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.
Example: Carolyn submits a pull request, Justin reviews the pull request and approves. However, Justin is still waiting on other checks (CI tests are usually the culprit), so he does not merge the pull request. Eventually, all of the checks pass. At this point, Carolyn or anyone else may merge the pull request.
First, the person contributing the code is putting themselves out there. Be mindful of what you say in a review.
- Ask clarifying questions
- State your understanding and expectations
- Provide example code or alternate solutions, and explain why
This is your chance for a mentoring moment of another developer. Take time to give an honest and thorough review of what has changed. Things to consider:
- Does the commit message explain what is going on?
- Does the code changes have tests? Not all changes need new tests, some changes are refactorings
- Do new or changed methods, modules, and classes have documentation?
- Does the commit contain more than it should? Are two separate concerns being addressed in one commit?
- Does the description of the new/changed specs match your understanding of what the spec is doing?
- Did the Continuous Integration tests complete successfully?
If you are uncertain, bring other contributors into the conversation by assigning them as a reviewer.
- General GitHub documentation
- GitHub pull request documentation
- Pro Git is both a free and excellent book about Git.
- A Git Config for Contributing