inst/docs/CONTRIBUTING.md

In whjelmar/rolemapr: A package to produce roles and responsibility maps

How to Contribute

We're excited you're interested in contributing to rolemapr! We'd love your help.

We welcome all levels of expertise from novice to experts.

If you are very new to the open source contribution: Fork this repo Star this repo and your own fork In Issues tab, read some that interests you You can Follow us on twitter, https://twitter.com/whjelmar

TODO - project twitter??

Further, check the Resources section at the bottom of this page.

There are plenty of ways to contribute:

• Fix or report a bug
• Fix or improve documentation
• Pick up a "good first issue", then send a pull request our way

We feel that a welcoming community is important and we ask that you follow the Contributor Covenant Code of Conduct in all interactions with the community.

Development

To run the entire test suite:

TODO

You can also run individual tests using the flag --tests:

TODO

Or run tests by category:

TODO

Coding Style Guide

TODO

Submitting a Pull Request

1. Fork and clone the repository
2. Make sure all tests pass locally: ./gradlew test
3. Create a new branch: git checkout -b feature/my-cool-new-feature
4. Make change on your cool new branch
5. Write a test for your change
6. Make sure source files are formatted: see Coding Style Guide above
7. Make sure to sign you work
8. Push change to your fork and submit a pull request
9. Work with project maintainers to get your change reviewed and merged into the main branch
10. Delete your branch

To ensure your pull request is accepted, follow these guidelines:

• All changes should be accompanied by tests
• Do your best to have a well-formed commit message for your change
• Keep diffs small and self-contained
• If your change fixes a bug, please link the issue in your pull request description
• Any changes to the API reference requires regenerating the static openapi.html file.

Note: A pull request should generally contain only one commit (use git commit --amend and git push --force or squash existing commits into one).

Branching

• Use a group at the beginning of your branch names

wip Work on a feature is still in progress feature Add or expand a feature bug Fix a bug

For example:

wip/my-cool-new-wip-feature feature/my-cool-new-feature feature/my-other-cool-new-feature bug/my-bug-fix bug/my-other-bug-fix

• Choose short and descriptive branch names
• Use dashes (-) to separate words in branch names
• Use lowercase in branch names

Sign Your Work

The sign-off is a simple line at the end of the message for a commit. All commits needs to be signed. Your signature certifies that you wrote the patch or otherwise have the right to contribute the material (see Developer Certificate of Origin):

This is my commit message

Signed-off-by: Walter Hjelmar <[e-mail]>

Git has a -s command line option to append this automatically to your commit message:

$ git commit -s -m "This is my commit message"

API Docs

TODO

To bundle:

$ redoc-cli bundle docs/openapi.yml -o docs/openapi.html  --title "rolemapr API Reference"

To serve:

$ redoc-cli serve docs/openapi.yml

Then browse to: http://localhost:8080

Note: To bundle or serve the API docs, please install redoc-cli.

Resources

• How to Contribute to Open Source
• Using the Fork-and-Branch Git Workflow
• Keep a Changelog
• Code Review Developer Guide
• Signing Commits

whjelmar/rolemapr documentation built on Aug. 8, 2022, 1:32 p.m.