contribution - WatsonGroupTCD/J2suscep GitHub Wiki

Contributing

Bugs reports and feature requests

If you think you've found a bug, please report it on the Issue Tracker. You can also propose ideas for new features or ask questions about the design of J2suscep here. Poor documentation can also be considered a bug, but please be as specific as possible when asking for improvements.

Code contributions

We welcome your contributions towards improving and extending the package and this is managed through Github pull requests. For external contributions we prefer the "fork and pull" workflow while core developers use branches in the main repository:

  1. First open an Issue to discuss the proposed contribution. This discussion might include how the changes fit J2suscep's scope and a general technical approach.
  2. Make your own project fork and implement the changes there.
  3. Open a pull request to merge the changes into the main project. A more detailed discussion can take place there before the changes are accepted.
⚠️ **GitHub.com Fallback** ⚠️