Skip to content

Commit

Permalink
Add branch and formatting notes
Browse files Browse the repository at this point in the history
  • Loading branch information
tw4l committed Nov 21, 2022
1 parent a1fb4f0 commit 2b87d3c
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,12 @@ When opening an issue or commenting on an open issue, please describe the proble

Please open a new pull request with a description of the changes and a link to the related issue (if no issue yet exists, please create one first).

Create a new branch with a short descriptive name including the issue number, based on the latest `main` branch.

All changes should be submitted with test coverage for the change as well as updates to the project documentation if appropriate.

Avoid making unnecessary changes such as reformatting code or otherwise touching parts of the codebase that are not directly relevant to the issue at hand.

We do our best to review pull requests in a timely manner but as we are a small team with many projects we cannot guarantee a response or merging timeline. Webrecorder reserves the right to reject pull requests that do not fit the direction of the project or ethics of the Webrecorder project.

The Development section below has information on how to get started with working on pywb in a local development environment.
Expand Down

0 comments on commit 2b87d3c

Please sign in to comment.