Firstly, thank you for your interest in contributing to Magnetar! We're thrilled to have you here.
- Before creating a bug report, please ensure the bug was not already reported by searching on GitHub under Issues.
- If you're unable to find an open issue addressing the problem, open a new one. Include a clear and descriptive title and provide as much relevant information as possible. A code sample or an executable test case demonstrating the expected behavior that is not occurring would be highly appreciated.
- If you have any ideas for how we could improve Magnetar, please don't hesitate to share them. Open a new issue with your suggestion.
- Fork the repository.
- Create a new branch (
git checkout -b new-feature). - Commit your changes (
git commit -am 'Add some feature'). - Push to the branch (
git push origin new-feature). - Create a new Pull Request.
- Use the present tense ("Add feature" not "Added feature").
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...").
- Limit the first line to 72 characters or less.
- Reference issues and pull requests liberally after the first line.
- Follow the PEP 8 style guide.
Thank you for spending some of your time to contribute. You're making Magnetar better for everyone!