@@ -5,20 +5,43 @@ or slack with the owners of this repository before making a change.
5
5
6
6
Please note we have a code of conduct, please follow it in all your interactions with the project.
7
7
8
- ## Pull Request Process
9
- In progress ...
8
+ ## Submitting issues
10
9
11
- ## Code of Conduct
12
- In progress ...
10
+ Bugs and enhancements are tracked in the ` issue tracker ` _ .
11
+ Before submitting a new issue, it is always a good idea to check is the
12
+ same bug or enhancement already reported. If it is, please add your
13
+ comments to the existing issue instead of creating a new one.
13
14
14
- ## Release steps
15
- Please follow the release steps for ensure that all release will be in the same standard and pattern.
15
+ ## Reporting bugs
16
16
17
- In progress ...
17
+ Explain the bug you have encountered so that others can understand it
18
+ and preferably also reproduce it. Key things to have in good bug report:
18
19
19
- ### Step for regenerate keywords documents
20
- Command for Generate document
20
+ - Python version information
21
+ - PuppeteerLibrary and Robot Framework version
22
+ - Steps to reproduce the problem. With more complex problems it is
23
+ often a good idea to create a short, self contained and example.
24
+ - Possible error message and traceback.
21
25
22
- python -m robot.libdoc -f html PuppeteerLibrary docs/PuppeteerLibrary.html
26
+ Notice that all information in the issue tracker is public. Do not
27
+ include any confidential information there.
23
28
29
+ ## Enhancement requests
30
+
31
+ Describe the new feature and use cases for it in as much detail as
32
+ possible in an issue. Especially with larger enhancements, be prepared to
33
+ contribute the code in form of a pull request as explained below or to
34
+ pay someone for the work. Consider also would it be better to implement this
35
+ functionality as a separate library outside the PuppeteerLibrary.
36
+
37
+ ## Pull requests
38
+
39
+ On GitHub pull requests are the main mechanism to contribute code. They
40
+ are easy to use both for the contributor and for person accepting the
41
+ contribution, and with more complex contributions it is easy also for
42
+ others to join the discussion. Preconditions for creating a pull
43
+ requests are having a ` GitHub account ` , installing ` Git ` and forking the
44
+ ` PuppeteerLibrary project ` .
45
+
46
+ Please always ensure that all test pass before create a pull request.
24
47
0 commit comments