Open Source Development Guidelines

Contributing

schedule 2 min read

To make it clear exactly how outside contributors should provide their contributions to the project, a CONTRIBUTING.md file should be created at the root of the repository. Once such a file exists, GitHub will present it to users creating new pull requests, issues, etc. in the repository. Here’s an example of how such a file can look like:

How to contribute

To contribute to the Swedbank Pay Development Guidelines, there’s just a few things you need to know.

Getting Started

  • Read and make sure you agree with the Code of Conduct.
  • Make sure you have a GitHub account.
  • Then, you have three options:
    1. Submit a ticket for your issue, assuming one does not already exist.
      • Clearly describe the issue including steps to reproduce when it is a bug.
      • Make sure you fill in the earliest version that you know has the issue.
    2. Directly edit the file you want to change on GitHub.
    3. Fork the repository on GitHub.

If you choose option 3 (forking the repository), then please read on.

Making Changes

  • Create a new branch from where you want to base your work.
    • This is usually the master or develop branch.
    • Please avoid working directly on the master and develop branch.
  • Make commits of logical units in the new branch.
  • Check for unnecessary whitespace with git diff --check before committing.
  • Make sure your commit messages are well written and in the proper format.
  • Push the branch to your forked repository (remote).
  • Submit a pull request for the pushed branch.