Thank you for considering contributing to weasel! We all wish to build a great framework together.
Following these guidelines will help the other developers to make the project grow, in a friendly environment.
Weasel is looking for all kind of contributions. Helping with the implementation or the design, writing documentation, tests and examples, are great ways to help the project. Using the library and providing your feedback is another great contribution.
Responsibilities
- Every change should be covered by tests.
- Create issues for any major changes and enhancements that you wish to make. Discuss things transparently and get community feedback.
- Be welcoming to newcomers and encourage diverse new contributors from all backgrounds.
You are welcome to open an issue with our design ideas or proposals. Otherwise, you can pick up a task from the project board.
Please follow this format to submit your changes.
- Create your own fork of the code
- Do the changes in your fork
- If you like the change and think the project could use it:
- Be sure you have followed the code style for the project (rustfmt).
- Open a pull request.
When filing an issue, try to answer these five questions:
- What version of Rust are you using?
- What operating system and processor architecture are you using?
- What did you do?
- What did you expect to see?
- What did you see instead?
As first step, you should check the wiki to ensure that your idea is not already in the roadmap!
Then, open an issue on our issues list on GitHub which describes the feature you would like to see, why you need it, and how it should work.
The maintainer looks at Pull Requests on a regular basis. He shall review the code in the next few days.
After feedback has been given we expect responses within two weeks. After two weeks we may close the pull request if it isn't showing any activity.