Permalink
Fetching contributors…
Cannot retrieve contributors at this time
49 lines (30 sloc) 2.66 KB

Contributing to sciencefair

We'd love you to contribute to sciencefair and make it more useful.

Here are some guidelines to help you engage and contribute:

Code of conduct

Help us keep sciencefair open and inclusive. Please read and follow our Code of Conduct.

Getting help

If you have questions about how to use sciencefair, we're available on gitter.

Found an issue?

If you find a mistake in the source code or documentation, you can help us by submitting an issue to our GitHub issue tracker.

Please take a look at the following guidelines before creating a new issue.

  1. Have you searched the issue archive to see if your question has already been answered or reported?

  2. If your issue appears to be a bug, and hasn't been reported, open a new issue. Help us to deal with issues efficiently by providing the following information:

    • Overview of the issue - including error messages / stack trace if an error is being thrown
    • Motivation / Use Case - explain why this is an issue for you
    • Version - which version of sciencefair are you using?
    • Operating System - what version are you using?
    • Node and npm versions - it may also be useful to include the output of npm list
    • Related issues - has a similar issue been reported before?
    • Suggest a fix - if you can't fix the bug yourself, perhaps you can point to what might be causing the problem (line of code or commit)
  3. If you can fix the issue yourself, create a Pull Request!

Want a feature?

You can request a new feature by submitting an issue to our GitHub Repository. It's very helpful if you can include a motivation / use case.

Want to contribute?

Contributions are very welcome. Take a look at the current issues and feature requests. Add a comment to an existing issue to mention that you plan to work on it.

If you'd like to implement a new feature, please open an issue to discuss any changes you would like to Pull Request. If the feature is likely to require major changes, please discuss it first on our gitter so that we can better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project.