-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
solving #2 issue: add PR template and contributing.md to answer reque…
…sts for PR #4
- Loading branch information
1 parent
a939edd
commit f578dcd
Showing
3 changed files
with
147 additions
and
81 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,71 +1,52 @@ | ||
| ## Description | ||
|
|
||
| <!-- | ||
| Please do not leave this blank | ||
| This PR [adds/removes/fixes/replaces] the [feature/bug/etc]. | ||
| --> | ||
|
|
||
| ## What type of PR is this? (check all applicable) | ||
|
|
||
| - [ ] 🍕 Feature | ||
| - [ ] 🐛 Bug Fix | ||
| - [ ] 📝 Documentation Update | ||
| - [ ] 🎨 Style | ||
| - [ ] 🧑💻 Code Refactor | ||
| - [ ] 🔥 Performance Improvements | ||
| - [ ] ✅ Test | ||
| - [ ] 🤖 Build | ||
| - [ ] 🔁 CI | ||
| - [ ] 📦 Chore (Release) | ||
| - [ ] ⏩ Revert | ||
| Please indicate whether this pull request [adds/removes/fixes/replaces] the [feature/bug/etc]. | ||
|
|
||
| ## What type of pull request is this? (check all applicable) | ||
|
|
||
| - [ ] Feature | ||
| - [ ] Bug Fix | ||
| - [ ] Documentation Update | ||
| - [ ] Style | ||
| - [ ] Code Refactor | ||
| - [ ] Performance Improvements | ||
| - [ ] Test | ||
| - [ ] Build | ||
| - [ ] CI | ||
| - [ ] Chore (Release) | ||
| - [ ] Revert | ||
|
|
||
| ## Related Tickets & Documents | ||
| <!-- | ||
| Please use this format link issue numbers: Fixes #123 | ||
| https://docs.github.com/en/free-pro-team@latest/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword | ||
| --> | ||
|
|
||
| ## Mobile & Desktop Screenshots/Recordings | ||
|
|
||
| <!-- Visual changes require screenshots --> | ||
|
|
||
| If possible ensure that you have provided in your commit message the issue id (available [here](https://github.com/onera/pml-analyzer/issues)) this pull request fixes, | ||
| for instance to refer to issue #42 you can do: | ||
| ```shell | ||
| git commit -m "solving issue #42 with ..." | ||
| ``` | ||
| Check [here](https://docs.github.com/en/free-pro-team@latest/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) for more information | ||
|
|
||
| ## Added tests? | ||
|
|
||
| - [ ] 👍 yes | ||
| - [ ] 🙅 no, because they aren't needed | ||
| - [ ] 🙋 no, because I need help | ||
| - [ ] yes | ||
| - [ ] no, because they aren't needed | ||
| - [ ] no, because I need help | ||
|
|
||
| ## Added to documentation? | ||
|
|
||
| - [ ] 📜 README.md | ||
| - [ ] 📓 docs.opensauced.pizza | ||
| - [ ] 🍕 dev.to/opensauced | ||
| - [ ] 📕 storybook | ||
| - [ ] 🙅 no documentation needed | ||
|
|
||
| ## [optional] Are there any post-deployment tasks we need to perform? | ||
|
|
||
|
|
||
|
|
||
| ## [optional] What gif best describes this PR or how it makes you feel? | ||
| - [ ] README.md | ||
| - [ ] doc | ||
| - [ ] no documentation needed | ||
|
|
||
| ## Do we need to update pml analyzer version? | ||
|
|
||
| - [ ] no | ||
| - [ ] the pull request is only a bug fix, need a bug fix version update | ||
| - [ ] the pull request add new features and ensures retro-compatibility, need a feature addition version update | ||
| - [ ] the pull request is not ensuring retro-capatibility, need a major version update | ||
| - [ ] not sure, I need help | ||
|
|
||
| <!-- note: PRs with deleted sections will be marked invalid --> | ||
| ## Is this new version should be released as soon as possible? | ||
|
|
||
| <!-- | ||
| For Work In Progress Pull Requests, please use the Draft PR feature, | ||
| see https://github.blog/2019-02-14-introducing-draft-pull-requests/ for further details. | ||
| For a timely review/response, please avoid force-pushing additional | ||
| commits if your PR already received reviews or comments. | ||
| Before submitting a Pull Request, please ensure you've done the following: | ||
| - 📖 Read the Open Sauced Contributing Guide: https://github.com/open-sauced/.github/blob/main/CONTRIBUTING.md. | ||
| - 📖 Read the Open Sauced Code of Conduct: https://github.com/open-sauced/.github/blob/main/CODE_OF_CONDUCT.md. | ||
| - 👷♀️ Create small PRs. In most cases, this will be possible. | ||
| - ✅ Provide tests for your changes. | ||
| - 📝 Use descriptive commit messages. | ||
| - 📗 Update any related documentation and include any relevant screenshots. | ||
| --> | ||
| - [ ] yes | ||
| - [ ] no | ||
| - [ ] not sure, I need help |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| # Contributing | ||
|
|
||
| When contributing to this repository, please first discuss the change you wish to make via issue, | ||
| email, or any other method with the owners of this repository before making a change. | ||
|
|
||
| ## Pull Request Process | ||
|
|
||
| 1. Fork, then clone the repo: | ||
| ```shell | ||
| git clone [email protected]:your-username/pml-analyzer.git | ||
| ``` | ||
| 2. See README.md to set up your machine. | ||
| 3. Make sure the tests pass: | ||
| ```shell | ||
| sbt test | ||
| ``` | ||
| 4. Make your change and please follow the [Scala 3 coding and documentation style guide](https://docs.scala-lang.org/style/). | ||
| 5. Add tests for your change. Make the tests pass: | ||
| ```shell | ||
| sbt test | ||
| ``` | ||
| 6. Update the README.md with details of changes to the API or the analysis process. | ||
| 7. Increase the version numbers in any examples files, the README.md and the build.sbt to the new version that this | ||
| Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/). | ||
| ```scala | ||
| //Change version in build.sbt | ||
| version := "X.Y.Z" | ||
| ``` | ||
| 8. You may merge the Pull Request in once you have the sign-off of two other developers, or if you | ||
| do not have permission to do that, you may request the second reviewer to merge it for you. | ||
|
|
||
| ## Code of Conduct | ||
|
|
||
| In the interest of fostering an open and welcoming environment, we as | ||
| contributors and maintainers pledge to making participation in our project and | ||
| our community a harassment-free experience for everyone, regardless of age, body | ||
| size, disability, ethnicity, gender identity and expression, level of experience, | ||
| nationality, personal appearance, race, religion, or sexual identity and | ||
| orientation. | ||
|
|
||
| ### Our Standards | ||
|
|
||
| Examples of behavior that contributes to creating a positive environment | ||
| include: | ||
|
|
||
| * Using welcoming and inclusive language | ||
| * Being respectful of differing viewpoints and experiences | ||
| * Gracefully accepting constructive criticism | ||
| * Focusing on what is best for the community | ||
| * Showing empathy towards other community members | ||
|
|
||
| Examples of unacceptable behavior by participants include: | ||
|
|
||
| * The use of sexualized language or imagery and unwelcome sexual attention or | ||
| advances | ||
| * Trolling, insulting/derogatory comments, and personal or political attacks | ||
| * Public or private harassment | ||
| * Publishing others' private information, such as a physical or electronic | ||
| address, without explicit permission | ||
| * Other conduct which could reasonably be considered inappropriate in a | ||
| professional setting | ||
|
|
||
| ### Our Responsibilities | ||
|
|
||
| Project maintainers are responsible for clarifying the standards of acceptable | ||
| behavior and are expected to take appropriate and fair corrective action in | ||
| response to any instances of unacceptable behavior. | ||
|
|
||
| Project maintainers have the right and responsibility to remove, edit, or | ||
| reject comments, commits, code, wiki edits, issues, and other contributions | ||
| that are not aligned to this Code of Conduct, or to ban temporarily or | ||
| permanently any contributor for other behaviors that they deem inappropriate, | ||
| threatening, offensive, or harmful. | ||
|
|
||
| ### Scope | ||
|
|
||
| This Code of Conduct applies both within project spaces and in public spaces | ||
| when an individual is representing the project or its community. Examples of | ||
| representing a project or community include using an official project e-mail | ||
| address, posting via an official social media account, or acting as an appointed | ||
| representative at an online or offline event. Representation of a project may be | ||
| further defined and clarified by project maintainers. | ||
|
|
||
| ### Attribution | ||
|
|
||
| This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, | ||
| available at [http://contributor-covenant.org/version/1/4][version] | ||
|
|
||
| [homepage]: http://contributor-covenant.org | ||
| [version]: http://contributor-covenant.org/version/1/4/ |