102 lines
3.6 KiB
Markdown
102 lines
3.6 KiB
Markdown
# Contributing
|
|
|
|
<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-refresh-toc -->
|
|
**Table of Contents**
|
|
|
|
- [Introduce](#introduce)
|
|
* [Code of Conduct](#code-of-conduct)
|
|
* [We Develop with Github](#we-develop-with-github)
|
|
* [Your First Contribution](#your-first-contribution)
|
|
* [Contribution Targets](#contribution-targets)
|
|
- [License](#license)
|
|
- [References](#references)
|
|
|
|
<!-- markdown-toc end -->
|
|
|
|
## Introduce
|
|
|
|
I'm really glad you're reading this, because we need volunteer developers to help this project come to fruition.
|
|
|
|
This document is intended to help, not burden you.
|
|
|
|
You can use it as a reference for various guidelines and information, and PR comfortably.
|
|
|
|
Please note we have a code of conduct, please follow it in all your interactions with the project.
|
|
|
|
### Code of Conduct
|
|
|
|
Refer to [CODE\_OF\_CONDUCT.md](./CODE_OF_CONDUCT.md).
|
|
|
|
### We Develop with Github
|
|
|
|
We use [github](https://github.com/black7375/Firefox-UI-Fix) to host code, to track [issues](https://github.com/black7375/Firefox-UI-Fix/issues) and feature requests, as well as accept [pull requests](https://github.com/black7375/Firefox-UI-Fix/pulls).
|
|
|
|
After feedback has been given we expect responses within two weeks. After two weeks we may close the issue and pull request if it isn't showing any activity.
|
|
|
|
### Your First Contribution
|
|
|
|
**Working on your first Pull Request?**
|
|
|
|
You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)
|
|
|
|
And, Please refer to the [development documentation](./docs/).
|
|
|
|
### Contribution Targets
|
|
|
|
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
|
|
|
|
**Codes**
|
|
- New Features.
|
|
- Bug fixes.
|
|
- Improved compatibility or accessibility.
|
|
- Refactoring.
|
|
|
|
**Graphic Resources**
|
|
- Icons ([#213](https://github.com/black7375/Firefox-UI-Fix/issues/213), We need the help of a designer!!)
|
|
- Social preview image ([sample](https://github.com/topics/firefox-theme))
|
|
|
|
**Issues**
|
|
- Report a bug.
|
|
- Discussing the current state of the code.
|
|
- Tell us about related or relevant projects and documents.
|
|
- Help other users issue.
|
|
- Proposing others..
|
|
|
|
**Docs**
|
|
- Fix typos, alignments.
|
|
- Correct awkward sentences.
|
|
- Improve document readability.
|
|
|
|
**Promotions**
|
|
- Introduce project
|
|
- Video (Recommend!!, We need it)
|
|
- Blog
|
|
- SNS
|
|
- Reddit, Hackernews..etc
|
|
- Sample
|
|
- [Producthunt](https://www.producthunt.com/posts/firefox-ui-fix-proton)([#43](https://github.com/black7375/Firefox-UI-Fix/issues/43))
|
|
- [Youtube](https://www.youtube.com/watch?v=ECta0icNMgY)
|
|
|
|
## License
|
|
|
|
**Any contributions you make will be under the MPL 2.0 Software License**
|
|
|
|
In short, when you submit code changes, your submissions are understood to be under the same [MPL 2.0 License](https://choosealicense.com/licenses/mpl-2.0/) that covers the project.
|
|
Feel free to contact the maintainers if that's a concern.
|
|
|
|
**Reference specification**
|
|
|
|
Even if you copy the code snippet, it is recommended that you leave a link.
|
|
|
|
**FAQ**
|
|
|
|
If you have any questions about other licenses, please see [Mozilla's MPL 2.0 FAQ](https://www.mozilla.org/en-US/MPL/2.0/FAQ/).
|
|
|
|
|
|
## References
|
|
|
|
- [Good-CONTRIBUTING.md-template](https://gist.github.com/PurpleBooth/b24679402957c63ec426)
|
|
- [Contributing to Transcriptase](https://gist.github.com/briandk/3d2e8b3ec8daf5a27a62)
|
|
- [contributing-template](https://github.com/nayafia/contributing-template/blob/master/CONTRIBUTING-template.md)
|
|
- [Contributing to Open Source Projects](https://www.contribution-guide.org/)
|