Contributing to Saturn
Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved!
Using the issue tracker
Use the issues tracker for:
Please do not use the issue tracker for personal or commercial support requests.
Personal support request should be discussed on Gitter.
Comercial support is provided by Lambda Factory and other companies specializing in F# consulting.
A bug is either a demonstrable problem that is caused by the code in the repository, or indicate missing, unclear, or misleading documentation. Good bug reports are extremely helpful - thank you!
Guidelines for bug reports:
Use the GitHub issue search — check if the issue has already been reported.
Check if the issue has been fixed — try to reproduce it using the
masterbranch in the repository.
Isolate and report the problem — ideally create a reduced test case.
Please try to be as detailed as possible in your report. Include information about
your Operating System, as well as your
mono \ .Net Framework), F# and Saturn versions. Please provide steps to
reproduce the issue as well as the outcome you were expecting! All these details
will help developers to fix any potential bugs.
Short and descriptive example bug report title
A summary of the issue and the environment in which it occurs. If suitable, include the steps required to reproduce the bug.
- This is the first step
- This is the second step
- Further steps, etc.
<url>- a link to the reduced test case (e.g. a GitHub Gist)
Any other information you want to share that is relevant to the issue being reported. This might include the lines of code that you have identified as causing the bug, and potential solutions (and your opinions on their merits).
Feature requests are welcome and should be discussed on issue tracker. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the community of the merits of this feature. Please provide as much detail and context as possible.
Good pull requests - patches, improvements, new features - are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.
IMPORTANT: By submitting a patch, you agree that your work will be licensed under the license used by the project.
If you have any large pull request in mind (e.g. implementing features, refactoring code, etc), please ask first otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project.
Please adhere to the coding conventions in the project (indentation, accurate comments, etc.) and don't forget to add your own tests and documentation. When working with git, we recommend the following process in order to craft an excellent pull request:
Fork the project, clone your fork, and configure the remotes:
# Clone your fork of the repo into the current directory git clone https://github.com/<your-username>/Saturn # Navigate to the newly cloned directory cd Saturn # Assign the original repo to a remote called "upstream" git remote add upstream https://github.com/Krzysztof-Cieslak/Saturn
If you cloned a while ago, get the latest changes from upstream, and update your fork:
git checkout master git pull upstream master git push
Create a new topic branch (off of
master) to contain your feature, change, or fix.
IMPORTANT: Making changes in
masteris discouraged. You should always keep your local
masterin sync with upstream
masterand make your changes in topic branches.
git checkout -b <topic-branch-name>
Commit your changes in logical chunks. Keep your commit messages organized, with a short description in the first line and more detailed information on the following lines. Feel free to use Git's interactive rebase feature to tidy up your commits before making them public.
Make sure all the tests are still passing.
Push your topic branch up to your fork:
git push origin <topic-branch-name>
Open a Pull Request with a clear title and description.
If you haven't updated your pull request for a while, you should consider rebasing on master and resolving any conflicts.
IMPORTANT: Never ever merge upstream
masterinto your branches. You should always
masterto bring your changes up to date when necessary.
git checkout master git pull upstream master git checkout <your-topic-branch> git rebase master