Skip to content

Latest commit

 

History

History
77 lines (47 loc) · 3.06 KB

CONTRIBUTING.md

File metadata and controls

77 lines (47 loc) · 3.06 KB
Raw

Contributing to BulletinBoard

The following is a set of guidelines for contributing to BulletinBoard on GitHub.

Above all, thank you for your interest in the project and for taking the time to contribute! 👍

I want to report a problem or ask a question

Before submitting a new GitHub issue, please make sure to

If the above doesn't help, please submit an issue on GitHub.

I want to contribute to BulletinBoard

Prerequisites

To develop BulletinBoard, you will need to use an Xcode version compatible with the Swift version specified in the README.

Checking out the repository

We use gitflow for PRs. The main branch contains the state of the latest released version. develop contains the changes from the current unreleased state. You create your PRs againts the develop branch.

  • Click the “Fork” button in the upper right corner of repo
  • Clone your fork:
    • git clone https://github.com/<YOUR_GITHUB_USERNAME>/BulletinBoard.git
  • Create a new branch to work on:
    • git checkout -b <YOUR_BRANCH_NAME>
    • A good name for a branch describes the thing you’ll be working on, e.g. voice-over, fix-font-size, etc.

That’s it! Now you’re ready to work on BulletinBoard. Open the BulletinBoard.xcworkspace workspace to start coding.

Things to keep in mind

  • Please do not change the minimum iOS version
  • Always document new public methods and properties

Testing your local changes

Before opening a pull request, please make sure your changes don't break things.

  • The framework and example project should build without warnings
  • The example project should run without issues.

Submitting the PR

When the coding is done and you’ve finished testing your changes, you are ready to submit the PR to the main repo, towards the develop branch. Some best practices are:

  • Use a descriptive title
  • Link the issues that are related to your PR in the body

After you open your PR, please update the CHANGELOG under the "Unreleased" tab with a link to your changes, under the appropriate section, and following this format:

- (Your changes, usually your PR title)
[#XXX](https://github.com/alexaubry/BulletinBoard/pulls/XXX)

The sections are:

  • ### New Features
  • ### Changed Behavior
  • ### Fixes

If you don't see the section under Unreleased, you can add it.

Code of Conduct

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

License

This project is licensed under the terms of the MIT license. See the LICENSE file.

These contribution guidelines were adapted from fastlane guides.