Skip to content

Latest commit

 

History

History
84 lines (57 loc) · 4.09 KB

CONTRIBUTING.md

File metadata and controls

84 lines (57 loc) · 4.09 KB

Contribution Guidelines

First off, thanks for taking the time to contribute! ❤️

All types of contributions are encouraged and valued. Beginners welcome! I look forward to your contributions. 🎉

And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:

  • Star the project
  • Tweet about it
  • Refer this project in your project's readme
  • Mention the project at local meetups and tell your friends/colleagues

Code of Conduct

This project and everyone participating in it is governed by the Steps Code of Conduct. By participating, you are expected to uphold this code.

I Have a Question

This repo is great for beginners! So if you have a question and need clarification, I recommend the following:

  • Open an Issue.
  • Provide as much context as you can about what you're running into.

I Want To Contribute

Legal Notice

When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project licence.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for Steps, including completely new features and minor improvements to existing functionality.

Before Submitting an Enhancement

  • Make sure that you are using the latest version.
  • Perform a search to see if the enhancement has already been suggested. If it has, add a comment to the existing issue.
  • Find out whether your idea fits with the scope and aims of the project.

How Do I Submit a Good Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues.

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Describe the current behaviour and explain which behaviour you expected to see instead and why. At this point you can also tell which alternatives do not work for you.
  • You may want to include screenshots which can help you demonstrate the steps or point out the part which the suggestion is related to.
  • Explain why this enhancement would be useful to most Steps users. You may also want to point out the other projects that solved it better and which could serve as inspiration.

Your First Code Contribution

  • Download Xcode 15.0 or later, and macOS 14.0 or later.
  • Fork the repo to your profile
  • Clone to your computer
  • Setup the upstream remote
git remote add upstream (/~https://github.com/brittanyarima/Steps.git

BEFORE starting on an issue, comment on the issue you want to work on.

  • This prevents two people from working on the same issue. The maintainer will assign you that issue, and you can get started on it.

  • Checkout a new branch (from the dev branch) to work on an issue:

git checkout -b issueNumber-feature-name
  • When your feature/fix is complete open a pull request, PR, from your feature branch to the dev branch
  • No commits should be made to the main branch directly. The main branch shall only consist of the deployed code

New to Git?

Attribution