..
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56 | # Welcome to Izuku contributing guide
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
- Becoming a maintainer
GitHub is being exclusively used to host code, to track issues and feature requests, as well as accept pull requests for this project. Following is a guideline for developing via GitHub:
## Pull requests
Pull requests are the best way to propose changes to the codebase (see [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests:
1. Fork the repo and create your branch from `main`.
2. If you've added code that should be tested, add tests.
3. If you've changed anything, update the documentation as well as list them in your pull request.
4. Ensure the test suite passes.
5. Make sure your code lints.
6. Issue that pull request!
## Bugs and Features
We use GitHub issues to track bugs and features. If you want to request a feature or report a bug by [opening a new issue](https://github.com/luciferreeves/izuku.js/issues/new/choose); it's that easy!
**PS:** Write bug reports with detail, background, and sample code
**Great Bug Reports** tend to have:
- A quick summary and/or background
- Steps to reproduce
- Be specific!
- Give sample code if you can.
- What you expected would happen
- What actually happens
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
People *love* thorough bug reports. We're not even kidding.
## Coding Style
Use a Consistent Coding Style. We borrowing these from [Facebook's Guidelines](https://github.com/facebook/draft-js/blob/master/CONTRIBUTING.md)
* 2 spaces for indentation rather than tabs
* 80 character line length
* try linting for style unification
## Your PR is merged!
Congratulations 🎉🎉 The Izuku thanks you ✨.
Once your PR is merged, your contributions will be publicly visible.
### Licensing
Any contributions you make will be under the MIT License. In short, when you submit code changes, your submissions are understood to be under the same [MIT License](https://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.
|
|
