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.
Please note we have a code of conduct, please follow it in all your interactions with the project.
To set up a development environment, please follow these steps:
-
Clone the repo
git clone https://github.com/Payadel/on_rails
-
Run
requirements.py
:- Option1:
python3 requirements.py
- Option2:
chmod +x requirements.py; ./requirements.py
- Option1:
-
Run
tox
and ensure everything is OK.
You've found a bug in the source code, a mistake in the documentation or maybe you'd like a new feature? You can help us by submitting an issue on GitHub. Before you create an issue, make sure to search the issue archive -- your issue may have already been addressed!
Please try to create bug reports that are:
- Reproducible. Include steps to reproduce the problem.
- Specific. Include as much detail as possible: which version, what environment, etc.
- Unique. Do not duplicate existing opened issues.
- Scoped to a Single Bug. One bug per report.
Even better: Submit a pull request with a fix or new feature!
- Search our repository for open or closed Pull Requests that relate to your submission. You don't want to duplicate effort.
- Fork the project
- Create your feature branch (
git checkout -b feat/amazing_feature
) - Commit your changes (
git commit -m 'feat: add amazing_feature'
)
This project uses conventional commits, so please follow the specification in your commit messages. You can see valid types from this file.
- Push to the branch (
git push origin feat/amazing_feature
) - Open a Pull Request