зеркало из https://github.com/github/libprojfs.git
add CONTRIBUTING.md
This commit is contained in:
Родитель
744fc0c86b
Коммит
bf55d5ecf2
|
@ -0,0 +1,46 @@
|
|||
## Contributing
|
||||
|
||||
[code-of-conduct]: CODE_OF_CONDUCT.md
|
||||
[commit]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
|
||||
[fork]: https://github.com/github/libprojfs/fork
|
||||
[libfuse]: https://github.com/libfuse/libfuse
|
||||
[pr]: https://github.com/github/libprojfs/compare
|
||||
[release]: https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license
|
||||
[style]: https://www.kernel.org/doc/html/latest/process/coding-style.html
|
||||
|
||||
Hi there! We're thrilled that you'd like to contribute to this project.
|
||||
Your help is essential for keeping it great.
|
||||
|
||||
Contributions to this project are [released][release] to the public under
|
||||
the [LGPL v2.1](COPYING).
|
||||
|
||||
Please note that this project is released with a
|
||||
[Contributor Code of Conduct][code-of-conduct].
|
||||
By participating in this project you agree to abide by its terms.
|
||||
|
||||
## Submitting a pull request
|
||||
|
||||
0. [Fork][fork] and clone the repository
|
||||
0. Configure and install the dependencies: `libfuse`
|
||||
0. Make sure the tests pass on your machine: `make test`
|
||||
0. Create a new branch: `git checkout -b my-branch-name`
|
||||
0. Make your change, add tests, and make sure the tests still pass
|
||||
0. Push to your fork and [submit a pull request][pr]
|
||||
0. Pat your self on the back and wait for your pull request to be reviewed
|
||||
and merged.
|
||||
|
||||
Here are a few things you can do that will increase the likelihood of
|
||||
your pull request being accepted:
|
||||
|
||||
- Follow the [style guide][style].
|
||||
- Write tests.
|
||||
- Keep your change as focused as possible. If there are multiple changes
|
||||
you would like to make that are not dependent upon each other, consider
|
||||
submitting them as separate pull requests.
|
||||
- Write a [good commit message][commit].
|
||||
|
||||
## Resources
|
||||
|
||||
- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
|
||||
- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
|
||||
- [GitHub Help](https://help.github.com)
|
|
@ -14,7 +14,7 @@ See the [design document](/docs/design.md).
|
|||
|
||||
## Contributing
|
||||
|
||||
*TBD with Code of Conduct*
|
||||
See [CONTRIBUTING](CONTRIBUTING.md) and [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md).
|
||||
|
||||
## Licensing
|
||||
|
||||
|
|
Загрузка…
Ссылка в новой задаче