Skip to content

Latest commit

 

History

History
69 lines (38 loc) · 2.94 KB

CONTRIBUTING.md

File metadata and controls

69 lines (38 loc) · 2.94 KB
Raw

Contributing

Contributions are welcome!

Please carefully read this page to make the code review process go as smoothly as possible and to maximize the likelihood of your contribution being merged.

A Note to Contributors

First, thank you for your interest in improving the SAWS project.

The first commit for SAWS went in on August 24 2015, so the project is still in its beginning stages. Before investing a lot of time, I wanted to ship a minimum feature set early on to gather feedback about whether this was something the community thought is valuable. Now that we've gained interest I'd like to make the codebase easier to work with. I'm overhauling the code pretty heavily at the moment, doing considerable refactoring to try simplify future development.

If you're thinking of some adding completions for options or resources, or you have some beefy changes in mind, you might want to hold off until I wrap up this ticket.

-Donne

Bug Reports

For bug reports or requests submit an issue.

Pull Requests

The preferred way to contribute is to fork the main repository on GitHub.

  1. Fork the main repository. Click on the 'Fork' button near the top of the page. This creates a copy of the code under your account on the GitHub server.

  2. Clone this copy to your local disk:

     $ git clone [email protected]:YourLogin/saws.git
 $ cd saws

  3. Create a branch to hold your changes and start making changes. Don't work in the master branch!

     $ git checkout -b my-feature

  4. Work on this copy on your computer using Git to do the version control. When you're done editing, run the following to record your changes in Git:

     $ git add modified_files
 $ git commit

  5. Push your changes to GitHub with:

     $ git push -u origin my-feature

  6. Finally, go to the web page of your fork of the SAWS repo and click 'Pull Request' to send your changes for review.

GitHub Pull Requests Docs

If you are not familiar with pull requests, review the pull request docs.

Code Quality

Ensure your pull request satisfies all of the following, where applicable:

Review the following style guide.

Run code checks and fix any issues:

$ scripts/run_code_checks.sh

Installation

Refer to the Installation and Developer Installation sections.