MoveUpwards/Sejima
1
1
Fork 0
mirror of https://github.com/MoveUpwards/Sejima.git synced 2024-11-09 17:52:18 +03:00
Code Issues Projects Releases Wiki Activity
7349be6253
Sejima/CONTRIBUTING.md
MoveUpwards 72470e32a5
Update CONTRIBUTING.md
2019-03-01 16:24:58 +01:00

3.3 KiB
Raw Blame History

Contribute to Sejima

First off, thanks for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to Sejima and its packages.

Before contributing, ensure that your effort is aligned with the project's roadmap by talking to the maintainers, especially if you are going to spend a lot of time on it. Feel free to join us on Slack if you are interested in helping us or drop us an email if you are interested in working with us.

Code of Conduct

This project and everyone participating in it is governed by the Sejima Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to mailto:hi@moveupwards.dev.

Open Development & Community Driven

Sejima is open-source under the MIT license. All the work done is available on GitHub. The core team and the contributors send pull requests which go through the same validation process.

Every user can send a feature request using the issues on GitHub. Feel free to upvote 👍 existing feature request

Repository Organization

We will do our best to keep the master branch as clean as possible, with tests passing all the times. However, it can happen that the master branch moves faster than the release cycle. To ensure you have the latest stable version, please refer to the release on cocoapods.

If you send a pull request, please do it against the master branch. We are developing upcoming versions separately to ensure non-breaking changes from master to the latest stable major version.

Setup Development Environment

To facilitate the contribution, we drastically reduce the amount of commands necessary to install the entire library. First of all, you need to check if you're using the required versions of xcode and swift version

Then, please follow the instructions below:

1. Fork the repository

Go to the repository and fork it to your own GitHub account.

2. Clone from your repository

git clone git@github.com:YOUR_USERNAME/sejima.git

Reporting an issue

Before reporting an issue you need to make sure:

  • You are experiencing a concrete technical issue with Sejima (ideas and feature proposals should happen on Slack).
  • You are not asking a question about how to use Sejima or about whether or not Sejima has a certain feature. For general help using Sejima, please refer to the official Sejima documentation. For additional help, ask a question on StackOverflow.
  • You have already searched for related issues, and found none open (if you found a related closed issue, please link to it in your post).
  • Your issue title is concise, on-topic and polite.
  • You can provide steps to reproduce this issue that others can follow.
  • You have tried all the following (if relevant) and your issue remains.