|
| 1 | +# Contributing Guide For Mirus |
| 2 | + |
| 3 | +This page lists the operational governance model of this project, as well as the recommendations and requirements for how to best contribute to Mirus. We strive to obey these as best as possible. As always, thanks for contributing – we hope these guidelines make it easier and shed some light on our approach and processes. |
| 4 | + |
| 5 | +# Governance Model |
| 6 | + |
| 7 | +## Salesforce Sponsored |
| 8 | + |
| 9 | +The intent and goal of open sourcing this project is to increase the contributor and user base. However, only Salesforce employees will be given `admin` rights and will be the final arbitrars of what contributions are accepted or not. |
| 10 | + |
| 11 | + |
| 12 | +# Issues, requests & ideas |
| 13 | + |
| 14 | +Use GitHub Issues page to submit issues, enhancement requests and discuss ideas. |
| 15 | + |
| 16 | +### Bug Reports and Fixes |
| 17 | +- If you find a bug, please search for it in the [Issues](https://github.com/salesforce/mirus/issues), and if it isn't already tracked, |
| 18 | + [create a new issue](https://github.com/salesforce/mirus/issues/new). Fill out the "Bug Report" section of the issue template. Even if an Issue is closed, feel free to comment and add details, it will still |
| 19 | + be reviewed. |
| 20 | +- Issues that have already been identified as a bug (note: able to reproduce) will be labelled `bug`. |
| 21 | +- If you'd like to submit a fix for a bug, [send a Pull Request](#creating_a_pull_request) and mention the Issue number. |
| 22 | + - Include tests that isolate the bug and verifies that it was fixed. |
| 23 | + |
| 24 | +### New Features |
| 25 | +- If you'd like to add new functionality to this project, describe the problem you want to solve in a [new Issue](https://github.com/salesforce/mirus/issues/new). |
| 26 | +- Issues that have been identified as a feature request will be labelled `enhancement`. |
| 27 | +- If you'd like to implement the new feature, please wait for feedback from the project |
| 28 | + maintainers before spending too much time writing the code. In some cases, `enhancement`s may |
| 29 | + not align well with the project objectives at the time. |
| 30 | + |
| 31 | +### Tests, Documentation, Miscellaneous |
| 32 | +- If you'd like to improve the tests, you want to make the documentation clearer, you have an |
| 33 | + alternative implementation of something that may have advantages over the way its currently |
| 34 | + done, or you have any other change, we would be happy to hear about it! |
| 35 | + - If its a trivial change, go ahead and [send a Pull Request](#creating_a_pull_request) with the changes you have in mind. |
| 36 | + - If not, [open an Issue](https://github.com/salesforce/mirus/issues/new) to discuss the idea first. |
| 37 | + |
| 38 | +If you're new to our project and looking for some way to make your first contribution, look for |
| 39 | +Issues labelled `good first contribution`. |
| 40 | + |
| 41 | +# Contribution Checklist |
| 42 | + |
| 43 | +- [x] Clean, simple, well styled code |
| 44 | +- [x] Commits should be atomic and messages must be descriptive. Related issues should be mentioned by Issue number. |
| 45 | +- [x] Comments |
| 46 | + - Module-level & function-level comments. |
| 47 | + - Comments on complex blocks of code or algorithms (include references to sources). |
| 48 | +- [x] Tests |
| 49 | + - The test suite, if provided, must be complete and pass |
| 50 | + - Increase code coverage, not versa. |
| 51 | + - Use any of our testkits that contains a bunch of testing facilities you would need. For example: `import com.salesforce.op.test._` and borrow inspiration from existing tests. |
| 52 | +- [x] Dependencies |
| 53 | + - Minimize number of dependencies. |
| 54 | + - Prefer Apache 2.0, BSD3, MIT, ISC and MPL licenses. |
| 55 | +- [x] Reviews |
| 56 | + - Changes must be approved via peer code review |
| 57 | + |
| 58 | +# Creating a Pull Request |
| 59 | + |
| 60 | +1. **Ensure the bug/feature was not already reported** by searching on GitHub under Issues. If none exists, create a new issue so that other contributors can keep track of what you are trying to add/fix and offer suggestions (or let you know if there is already an effort in progress). |
| 61 | +3. **Clone** the forked repo to your machine. |
| 62 | +4. **Create** a new branch to contain your work (e.g. `git br fix-issue-11`) |
| 63 | +4. **Commit** changes to your own branch. |
| 64 | +5. **Push** your work back up to your fork. (e.g. `git push fix-issue-11`) |
| 65 | +6. **Submit** a Pull Request against the `main` branch and refer to the issue(s) you are fixing. Try not to pollute your pull request with unintended changes. Keep it simple and small. |
| 66 | +7. **Sign** the Salesforce CLA (you will be prompted to do so when submitting the Pull Request) |
| 67 | + |
| 68 | +> **NOTE**: Be sure to [sync your fork](https://help.github.com/articles/syncing-a-fork/) before making a pull request. |
| 69 | +
|
| 70 | +# Contributor License Agreement ("CLA") |
| 71 | +In order to accept your pull request, we need you to submit a CLA. You only need |
| 72 | +to do this once to work on any of Salesforce's open source projects. |
| 73 | + |
| 74 | +Complete your CLA here: <https://cla.salesforce.com/sign-cla> |
| 75 | + |
| 76 | +# Issues |
| 77 | +We use GitHub issues to track public bugs. Please ensure your description is |
| 78 | +clear and has sufficient instructions to be able to reproduce the issue. |
| 79 | + |
| 80 | +# Code of Conduct |
| 81 | +Please follow our [Code of Conduct](CODE_OF_CONDUCT.md). |
| 82 | + |
| 83 | +# License |
| 84 | +By contributing your code, you agree to license your contribution under the terms of our project [LICENSE](LICENSE.txt) and to sign the [Salesforce CLA](https://cla.salesforce.com/sign-cla) |
0 commit comments