Skip to content

Latest commit

 

History

History
151 lines (103 loc) · 9.04 KB

CONTRIBUTING.md

File metadata and controls

151 lines (103 loc) · 9.04 KB
Raw

Contributing Guide

Thank you for considering contributing to simplnx. Your involvement helps make simplnx a valuable tool for the global scientific community.

This repository needs many different kinds of contribution not all of which require coding knowledge. Here are some of the different options:

  • For Non-Code Contributors:
    • Provide datasets to be used for testing filters
    • Documentation and comments can always be improved or expanded on to make it more accessible to users
    • Language translation for documenation is always appreciated since this software is used around the world
    • Suggest User Interface updates and/or add accesibility options
    • Create new logos or images
    • Report bugs and test GUI client which can be downloaded from dream3d.io
    • Answer questions from fellow users in DREAM3DNX-Issues discussions
  • For Python Developers:
    • Create new examples of use cases and as a Jupyter Notebook or sdd to documentation
    • Create filters for simplnx from new papers and dissertations
    • Fix bugs in filters or the python bindings
    • Update exisitng filters to expand functionality or optimize
  • For Operating System Power Users and CyberSecurity Experts:
    • Report security vulnerabilities in DREAM3DNX-Issues
    • Add CMake presets for compiling on unique operating systems not already supported
    • Create packages of DREAM3DNX and/or simplnx (with the nxrunner cli) and submit them to your favorite package manager (AUR, Flatpak, etc.)
    • Create ways to run simplnx (with the nxrunner cli) in containers (such as Docker container)
  • For C++ Developers:
    • Create new filters for simplnx from new papers and dissertations
    • Port old SIMPL filters to the updated simplnx framework porting filters guidelines
    • Handle bugs and feature requests: issue tracker
    • Create new test cases to improve the reliability and robustness of the filters
    • Update nxrunner cli to offer the same functionality as our GUI interface
    • Optimize existing filter algorithms
    • Port python filters to c++ to increase efficiency

Our repository recognizes all forms of contribution as defined in the all-contributors specification. The categories of which can be seen here emoji key;

Building from Source

For instructions on building from source see our Guide to Building From Source.

Getting Started

  1. Fork the repository to your GitHub account.
  2. Clone the repository to your local machine: git clone https://github.com/YOUR_USERNAME/simplnx.git
  3. Create a new branch: git checkout -b NAME_YOUR_BRANCH
  4. Make your changes and commit them: git commit -m 'Add some feature or fix some issue'
  5. Push your changes to your fork: git push origin NAME_YOUR_BRANCH
  6. Create a pull request from your branch to the simplnx main or master branch.

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct.

If you experience or witness unacceptable behavior—or have any other concerns—please report it by contacting the project maintainers at [email protected]. All reports will be handled with discretion.

How Can I Contribute?

Reporting Bugs

  1. Check the issue tracker to ensure the bug hasn't already been reported.
  2. If the bug hasn't been reported, create a new issue. Provide a clear description of the problem, including steps to reproduce.

Suggesting Enhancements

  1. Check the issue tracker to ensure the enhancement hasn't already been suggested.
  2. If not, create a new issue. Provide a clear description of the enhancement.

Handling Issues with Help Wanted Tag

  1. Check the issue tracker and sort by Help Wanted to see issues that aren't actively being handled internally.
  2. Once you select an issue, check for existing comments containing an "In Progress" title.
  3. If there is not an exitisting In Progress comment proceed to step 4, else do the following:
    • Check the Description of Planned Changes in the comment to see if the part of they are already handling the change you want to make. If not continue to step 4
    • Look at Extra Information to see if they are willing to accept help. If not select another change associated with the issue (if it has multiple tasks) or go select a new issue to work on.
    • Add a comment to the issue where you ping the collaborator with @ and their username and ask if you can help. Be sure to be polite and abide by our Code of Conduct.
  4. If theres not an existing comment, go a head and create a branch and add a comment to the issue formatted as follows:
## In Progress

### Description of Planned Changes

Example Description:
- Fix example bug
- Adding example feature
- Porting exampleModule documentation to example language
- Handling example task from checklist above

### Working Branch

[MyExampleFork/branch_type/branch_name](https://github.com/profileName/MyExampleFork/tree/branch_type/branch_name)

### Extra Information

Willing to Collaborate with Other Contributors on These Changes: Y/N

[Any other comments you may have]

Pull Requests

  1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  2. Ensure your code adheres to our existing coding standards.
  3. Include test cases wherever possible.
  4. Describe your changes in the pull request description.

Styleguides

Git Commit Messages

  • 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

Code Styleguide

For information about our specifc naming conventions and styling see our coding style guide.

For the basic code styling simplnx uses clang-format, the formatting file is included at the root level in the repository.

clang-format is a tool to automatically format C++ code. You should run 'clang-format' on your code before opening a Pull Request to make sure it passes the clang-format pr check. You can install clang-format and git-clang-format with npm install -g clang-format. To automatically format a file according to a project's C++ code style, run clang-format -i path/to/simplnx/file, which is supported on macOS/Linux/Windows. If you want to run clang-format on all the changed code on your latest git commit (HEAD), you can run git-clang-format HEAD~1. Run git-clang-format -h for extra help.

Documentation Styleguide

  • Use Markdown
  • Reference methods and classes in backticks (MethodName, ClassName)
  • Leave a blank newline at the end of file
  • Be sure to include the following at the bottom of all documentation files
## DREAM3D-NX Help ##

If you need help, need to file a bug report or want to request a new feature, please head over to the [DREAM3DNX-Issues](https://github.com/BlueQuartzSoftware/DREAM3DNX-Issues/discussions) GitHub site where the community of DREAM3D-NX users can help answer your questions.

Community

For those looking to engage with the DREAM3DNX community, see the discussions board of DREAM3DNX-Issues discussions. All of our filter documentation now links back to this repository.

Additional Notes

We put together a specifc discussion category, called Contributor Questions, where you can quickly get help with issues related to development directly from maintainers.

It is highly recommended for new code contributors to look at the porting filters guidelines to get a better idea of API and see how to bring older filters over from SIMPL.

Getting Credit for Your Contributions

Since our repository recognizes all contributions code or otherwise, feel free to add yourself to the Contributors section of the readme by following this tutorial. If you don't wan't to do it personally, one of the maintainers will do it when your Pull Request is approved unless you specifically state that you don't want to be added. Upon the GitHub PR being opened active maintainers will review your contributions then merge the PR by all-contributors-bot at which point you will appear in the main page under Contributors. The only requirement is having a GitHub account.

Thank you for contributing!