Skip to content

Commit 17afd33

Browse files
committed
Update PR template + contributing guidelines
1 parent 90dfd52 commit 17afd33

File tree

2 files changed

+6
-15
lines changed

2 files changed

+6
-15
lines changed

.github/pull_request_template.md

-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
(Add x between brackets to check.)
44

55
- [ ] I’ve read [contributing guidelines](../contributing.md)
6-
- [ ] I’ve signed and sent the [Readium ICLA](http://readium.github.io/documents/Individual%20Contributor%20License%20Agreement.pdf) (no need if your PR is about fixing typos)
76
- [ ] I’m making this pull request against the develop branch
87
- [ ] I’ve updated from the develop branch before proposing this pull request
98
- [ ] I’ve tested the changes for bug fixes and/or features

contributing.md

+6-14
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Readium CSS has been design following 4 principles:
2525
3. **Daisy-chainability:** those modules can be loaded and daisy-chained (cascade), depending on conditions;
2626
4. **Customization:** modules can be customized either before or during runtime (CSS variables).
2727

28-
Please keep those principles in mind before making a pull request. If you have any doubt, please feel free to contact [Jiminy Panoz](mailto:[email protected]).
28+
Please keep those principles in mind before making a pull request. If you have any doubt, please feel free to contact [maintainers](mailto:[email protected]).
2929

3030
## Testing
3131

@@ -38,7 +38,7 @@ You can either:
3838

3939
In any case, you have to manually inject stylesheets and apply settings via the console, or design and code scripts if you want a GUI (user settings menu).
4040

41-
You can use the [RS-streamer-js](https://github.com/edrlab/r2-streamer-js) to manage EPUB files if needed.
41+
You can use the [R2-streamer-js](https://github.com/edrlab/r2-streamer-js) to manage EPUB files if needed.
4242

4343
## Coding Standards
4444

@@ -114,7 +114,7 @@ This applies to the custom properties as well:
114114

115115
If possible, user settings must be inherited from the `--USER__variable` set on `:root`. This obviously can’t be done for all user settings as it depends on the scope (the elements targeted).
116116

117-
User settings must also abide by [those recommendations](https://github.com/readium/readium-css/issues/5).
117+
User settings must also abide by [these recommendations](https://readium.org/readium-css/docs/CSS14-user_settings_recs.html).
118118

119119
## How Can I Contribute?
120120

@@ -124,7 +124,7 @@ First and foremost, check if your issue has already been reported (don’t forge
124124

125125
Before opening any issue…
126126

127-
- **Ensure your EPUB is valid.** Always validate your EPUB against [EPUBCheck](http://validator.idpf.org). If there are errors or warnings, please fix those before submitting an issue.
127+
- **Ensure your EPUB is valid.** Always validate your EPUB against [EPUBCheck](https://github.com/w3c/epubcheck). If there are errors or warnings, please fix those before submitting an issue.
128128
- **Create an isolated and reproducible test case.** Be sure the problem exists in Readium CSS (try your HTML in the browser). Try providing a [reduced test case](https://css-tricks.com/reduced-test-cases/).
129129
- **Share as much information as possible.** See below.
130130

@@ -229,7 +229,7 @@ I'm submitting a…
229229

230230
### Your First Code Contribution
231231

232-
Unsure where to begin contributing to the Readium CSS Project? You can start by looking through the `feedback-required` and/or `low-hanging fruit` issues, or the [Roadmap section](#roadmap).
232+
Unsure where to begin contributing to the Readium CSS Project? You can start by looking through the `feedback-required` and/or `low-hanging fruit` issues.
233233

234234
Then fork the repo, create a branch named after the issue you’re trying to solve, and implement your modifications.
235235

@@ -239,18 +239,10 @@ We’ll finally review your pull request to check if everything is OK.
239239

240240
### Pull Requests
241241

242-
First, make sure you have signed and sent the [Readium ICLA](http://readium.github.io/documents/Individual%20Contributor%20License%20Agreement.pdf) (for Individual Contributor License Agreement) – no need if your PR is about fixing typos.
243-
244242
- Test your code (see [platform support](https://github.com/readium/readium-css/wiki/Platform-Support) in the Wiki).
245243
- Pull requests should **always** be created against the develop branch – never the master.
246244
- Please update from the develop branch before proposing a pull request so that we don’t have to deal with conflicts.
247245
- Use a clear and descriptive title.
248246
- List all fixes and enhancements the pull request provides.
249247
- Include screenshots and/or animated GIF whenever possible – no need to do that for correcting typos in docs for instance.
250-
- Document new code.
251-
252-
## Roadmap
253-
254-
The [up-to-date roadmap can be found in the Wiki](https://github.com/readium/readium-css/wiki/Roadmap).
255-
256-
Progress is publicly tracked in [issue #11](https://github.com/readium/readium-css/issues/11).
248+
- Document new code.

0 commit comments

Comments
 (0)