mirror of
https://github.com/gsi-upm/sitc
synced 2024-12-22 11:48:12 +00:00
127 lines
4.9 KiB
Markdown
127 lines
4.9 KiB
Markdown
# Contributing
|
|
|
|
When contributing to this repository, please consider the scope of your contribution.
|
|
For major corrections (other than typos and minor code changes), please first discuss the change you wish to make via a GitHub issue,
|
|
email, or any other method with the owners of this repository before working on your change.
|
|
If you fail to do so, your contribution may be rejected.
|
|
|
|
Also note that we have a code of conduct, please follow it in all your interactions with the project.
|
|
|
|
## Pull Request Process
|
|
|
|
0. Read GitHub's [documentation on pull requests](https://help.github.com/articles/creating-a-pull-request/)
|
|
1. Clone the repository locally, or fork it using GitHub.
|
|
2. If you are adding code, ensure the changed notebooks can be run in a fresh environment. Include instructions to download
|
|
any additional dependencies.
|
|
3. Ensure any spurious changes are removed, such as compilation files (`pyc`) or metadata changes in a notebook.
|
|
You can automatically do so using nbstripout:
|
|
```
|
|
pip install nbstripout
|
|
nbstripout --install
|
|
```
|
|
This will install a git hook that strips all metadata from the notebooks before you commit changes to git.
|
|
|
|
You can also remove the output from all cells using this command:
|
|
|
|
```
|
|
make clean
|
|
```
|
|
|
|
To limit the command to a specific folder (e.g. ml1):
|
|
```
|
|
make FOLDER=ml1 clean
|
|
```
|
|
4. Submit your pull request on GitHub.
|
|
5. A member of the GSI-UPM group will review your request.
|
|
6. The reviewer may ask for further changes before merging the contribution. Please, follow the reviewer's instructions before resubmitting.
|
|
|
|
|
|
## Testing the changes
|
|
|
|
You can execute all notebooks at once to make sure they work with this command:
|
|
|
|
```
|
|
make exec
|
|
```
|
|
|
|
To only check notebooks in a specific folder, run:
|
|
|
|
```
|
|
make FOLDER=ml2 exec # Run all notebooks in the ml2 folder
|
|
```
|
|
|
|
## Code of Conduct
|
|
|
|
### Our Pledge
|
|
|
|
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.
|
|
|
|
### Enforcement
|
|
|
|
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
|
reported by contacting the project team at admin-gsi@dit.upm.es. All
|
|
complaints will be reviewed and investigated and will result in a response that
|
|
is deemed necessary and appropriate to the circumstances. The project team is
|
|
obligated to maintain confidentiality with regard to the reporter of an incident.
|
|
Further details of specific enforcement policies may be posted separately.
|
|
|
|
Project maintainers who do not follow or enforce the Code of Conduct in good
|
|
faith may face temporary or permanent repercussions as determined by other
|
|
members of the project's leadership.
|
|
|
|
### 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/
|