Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
webdesus committed May 4, 2022
1 parent 752fc4d commit 6b90de0
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Contribute to fs_extra
## About me
Hello everyone, my name is Denis. I'm a maintainer at the current time of this project. I begin to write when I study rust. Because the current code base has some inconvenience. When I work full time on rust in other projects I found it. But don't have free time to fix it. Many people make a request to get full access to fs_extra and I'm ready to do it. But I should make sure that the project moves into good hands. Because I planing find 3 hours per week for this project. I'm not sure I have time for programming. But this time I plan to spend on a merge PR, publish a new version, and answer issues. Maybe sometime I found time for codding. But my life very changed much after 24 February when war is begin... When my stupid government begins it. I lost my business and lеft my country because I don't support what Russians dot it right now. And this little step, what I can do. I've tried to go to the street and say I am against it, but people who follow Russia they know how it ends. Right now have a more important task in my life to survive.

## Report for bugs
We use GitHub issues for our public bugs. If you would like to report a problem, take a look around and see if someone already opened an issue about it. If you are certain this is a new unreported bug, you can submit a bug report.
If you have questions about using fs_extra you can ask us in [Discussions](https://github.com/webdesus/fs_extra/discussions)

## Pull request
So you have decided to contribute code back to upstream by opening a pull request. You've invested a good chunk of time, and we appreciate it. We will do our best to work with you and get the PR looked at.
Your PR will be awesome if he follows:
- Dependencies are optional. If you add a feature that requires installing a new library this feature should use Rust compile option for switch on. Default off.
Structs and methods for new features which will be using external lib should contain in `src/features/` folder.
- Contains test cases if you add new features.
## RFC
We store RFC documents using md format in `src/rfc` folder. Using PR mechanism you can offer new ideas for our project

0 comments on commit 6b90de0

Please sign in to comment.