Skip to content

Commit e4c47c7

Browse files
Mec-iSmorenol
Mec-iS
authored and
morenol
committed
Add contribution guidelines (#178)
1 parent f4fd4d2 commit e4c47c7

File tree

6 files changed

+129
-1
lines changed

6 files changed

+129
-1
lines changed

‎.github/CODEOWNERS

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# These owners will be the default owners for everything in
2+
# the repo. Unless a later match takes precedence,
3+
# Developers in this list will be requested for
4+
# review when someone opens a pull request.
5+
* @VolodymyrOrlov
6+
* @morenol
7+
* @Mec-iS

‎.github/CODE_OF_CONDUCT.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Code of Conduct
2+
3+
As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
4+
5+
We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality.
6+
7+
Examples of unacceptable behavior by participants include:
8+
9+
* The use of sexualized language or imagery
10+
* Personal attacks
11+
* Trolling or insulting/derogatory comments
12+
* Public or private harassment
13+
* Publishing other's private information, such as physical or electronic addresses, without explicit permission
14+
* Other unethical or unprofessional conduct.
15+
16+
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. By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project. Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team.
17+
18+
This code of conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.
19+
20+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
21+
22+
This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.2.0, available at [http://contributor-covenant.org/version/1/2/0/](http://contributor-covenant.org/version/1/2/0/)

‎.github/CONTRIBUTING.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# **Contributing**
2+
3+
When contributing to this repository, please first discuss the change you wish to make via issue,
4+
email, or any other method with the owners of this repository before making a change.
5+
6+
Please note we have a [code of conduct](CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.
7+
8+
## Pull Request Process
9+
10+
1. Open a PR following the template.
11+
2. Update the CHANGELOG.md with details of changes to the interface if they are breaking changes, this includes new environment variables, exposed ports useful file locations and container parameters.
12+
3. Pull Request can be merged in once you have the sign-off of one other developer, or if you do not have permission to do that you may request the reviewer to merge it for you.
13+
14+
## Issue Report Process
15+
16+
1. Go to the project's issues.
17+
2. Select the template that better fits your issue.
18+
3. Read carefully the instructions and write within the template guidelines.
19+
4. Submit it and wait for support.
20+
21+
## Reviewing process
22+
23+
1. After a PR is opened maintainers are notified
24+
2. Probably changes will be required to comply with the workflow, these commands are run automatically and all tests shall pass:
25+
* **Coverage**: `tarpaulin` is used with command `cargo tarpaulin --out Lcov --all-features -- --test-threads 1`
26+
* **Linting**: `clippy` is used with command `cargo clippy --all-features -- -Drust-2018-idioms -Dwarnings`
27+
* **Testing**: multiple test pipelines are run for different targets
28+
3. When everything is OK, code is merged.
29+
30+
31+
## Contribution Best Practices
32+
33+
* Read this [how-to about Github workflow here](https://guides.github.com/introduction/flow/) if you are not familiar with.
34+
35+
* Read all the texts related to [contributing for an OS community](https://github.com/HTTP-APIs/hydrus/tree/master/.github).
36+
37+
* Read this [how-to about writing a PR](https://github.com/blog/1943-how-to-write-the-perfect-pull-request) and this [other how-to about writing a issue](https://wiredcraft.com/blog/how-we-write-our-github-issues/)
38+
39+
* **read history**: search past open or closed issues for your problem before opening a new issue.
40+
41+
* **PRs on develop**: any change should be PRed first in `development`
42+
43+
* **testing**: everything should work and be tested as defined in the workflow. If any is failing for non-related reasons, annotate the test failure in the PR comment.

‎.github/ISSUE_TEMPLATE.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
### I'm submitting a
2+
- [ ] bug report.
3+
- [ ] feature request.
4+
5+
### Current Behaviour:
6+
<!-- Describe about the bug -->
7+
8+
### Expected Behaviour:
9+
<!-- Describe what will happen if bug is removed -->
10+
11+
### Steps to reproduce:
12+
<!-- If you can then please provide the steps to reproduce the bug -->
13+
14+
### Snapshot:
15+
<!-- If you can then please provide the screenshot of the issue you are facing -->
16+
17+
### Environment:
18+
<!-- Please provide the following environment details if relevant -->
19+
* rustc version
20+
* cargo version
21+
* OS details
22+
23+
### Do you want to work on this issue?
24+
<!-- yes/no -->

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<!-- Please create (if there is not one yet) a issue before sending a PR -->
2+
<!-- Add issue number (Eg: fixes #123) -->
3+
<!-- Always provide changes in existing tests or new tests -->
4+
5+
Fixes #
6+
7+
### Checklist
8+
- [ ] My branch is up-to-date with development branch.
9+
- [ ] Everything works and tested on latest stable Rust.
10+
- [ ] Coverage and Linting have been applied
11+
12+
### Current behaviour
13+
<!-- Describe the code you are going to change and its behaviour -->
14+
15+
### New expected behaviour
16+
<!-- Describe the new code and its expected behaviour -->
17+
18+
### Change logs
19+
20+
<!-- #### Added -->
21+
<!-- Edit these points below to describe the new features added with this PR -->
22+
<!-- - Feature 1 -->
23+
<!-- - Feature 2 -->
24+
25+
26+
<!-- #### Changed -->
27+
<!-- Edit these points below to describe the changes made in existing functionality with this PR -->
28+
<!-- - Change 1 -->
29+
<!-- - Change 1 -->

‎README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,7 @@
1515
<b>The Most Advanced Machine Learning Library In Rust.</b>
1616
</p>
1717

18-
-----
18+
-----
19+
20+
21+
Contributions welcome, please start from [CONTRIBUTING and other relevant files](.github/CONTRIBUTING.md).

0 commit comments

Comments
 (0)