Contributing [WIP]

When wishing to contribute please first contact one of the project maintainers. This project still has a WIP status, and as such has issues which take priority over others.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Be advised that we are using Ruby version 2.5.0.

To get started on the project locally, clone and bundle it.

Workflow

1. Choose a ticket. Having chosen a ticket, create a branch locally. The branch name should start with the number of the ticket/issue i.e. 81-write-a-test
2. Write a test. While we understand that not everyone writes using TDD, we insist on keeping a high level of test coverage in our project. If you add new code, please write a test.
3. Make sure the existing tests pass. Please make sure the existing tests pass
4. Create a Pull Request. Push your branch to our repo, and create a pull request. If you are ready for your code to be reviewed, please use the Code Review flag. Your pull request will then be reviewed. In your Pull Request, please state your steps for QA-ing your branch. This will make it clearer for those who review your pull request, and easier for you when you come to QA it.
5. Test your branch in our SandBox. Push your branch to our SandBox, and smoke test the application to make sure that everything still works as it should. Please also follow your own stated QA steps.
6. Merge your branch to master. Once your tests pass, your code has been reviewed and your branch successfully tested on our SandBox, then you can merge your branch to master.

Code of Conduct

Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

Our Standards

Examples of behavior that contributes to creating a positive environment include:

• Using welcoming and inclusive language
• Being respectful of differing viewpoints and experiences
• Gracefully accepting constructive criticism
• Focusing on what is best for the community
• Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

• The use of sexualized language or imagery and unwelcome sexual attention or advances
• Trolling, insulting/derogatory comments, and personal or political attacks
• Public or private harassment
• Publishing others' private information, such as a physical or electronic address, without explicit permission
• Other conduct which could reasonably be considered inappropriate in a professional setting

Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

Scope

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

Attribution

This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at http://contributor-covenant.org/version/1/4