Cloudy & Associates

Commit 294c4efd authored by Marios Chatzikos's avatar Marios Chatzikos
Browse files

Extract text from README.md into CONTRIBUTING.md

parent 7b3f264d
Contributing
============
If you wish to extend ADM to handle in any way (e.g., add support for other
data formats), you are **more than welcome to contribute**.
All you need to do is:
1. Fork the project (`git clone ...`)
2. Create a feature branch (`git checkout -b feature`)
3. Commit your changes (`git commit -a -m"Add new feature"`)
4. Push featre branch to remote repo (`git push origin feature`)
5. Create a Pull Request
Please comply with the adopted code style, as detailed below.
Thanks!
Code Style
----------
The coding style conforms to PEP8, except that spaces are used around
parentheses, and function keywords.
Line breaks around binary operators are used before, rather than after, the
operator.
These choices may be monitored and enforced with `scripts/code-style.sh`.
Please use this tool on your changes and make sure it passes clean before you
submit a pull request.
Alternatively, you may run
```
make check
```
which will run this script to `check` for code-style violations for you.
Either way you need to resolve any violations before you commit.
Committing Code
---------------
Commit messages being an important element of revision control, it is
important that one be written following
[this pattern](https://cbea.ms/git-commit/#why-not-how).
As a facility, the next commands
```
make prep
vi msg
make commit
```
will carry out the desired outcome.
The first generates a file called `msg` that contains all the changes that
will be part of the commit.
Edit the file to the desired format, and issue the last command to carry out
the commit.
Note that:
1. `make prep` runs the code style checker automatically;
2. these commands will commit all changes to the repo, using the commit message
in `msg'. Finer control is offered by `scripts/prep-commit` and
`scripts/do-commit`. You may run git commands directly, too -- your choice;
just keep in mind to conform to the code style, and the commit message format.
Bug Reports
-----------
If you encounter a bug, please create an Issue at
[https://gitlab.com/astrop.mc/adm](https://gitlab.com/astrop.mc/adm).
......@@ -122,76 +122,6 @@ cd tests
Once there, you can also monitor the performance of the slowest test in the
suite.
Contributing
============
If you wish to extend ADM to handle in any way (e.g., add support for other
data formats), you are **more than welcome to contribute**.
All you need to do is:
1. Fork the project (`git clone ...`)
2. Create a feature branch (`git checkout -b feature`)
3. Commit your changes (`git commit -a -m"Add new feature"`)
4. Push featre branch to remote repo (`git push origin feature`)
5. Create a Pull Request
Please comply with the adopted code style, as detailed below.
Thanks!
Code Style
----------
The coding style conforms to PEP8, except that spaces are used around
parentheses, and function keywords.
Line breaks around binary operators are used before, rather than after, the
operator.
These choices may be monitored and enforced with `scripts/code-style.sh`.
Please use this tool on your changes and make sure it passes clean before you
submit a pull request.
Alternatively, you may run
```
make check
```
which will run this script to `check` for code-style violations for you.
Either way you need to resolve any violations before you commit.
Committing Code
---------------
Commit messages being an important element of revision control, it is
important that one be written following
[this pattern](https://cbea.ms/git-commit/#why-not-how).
As a facility, the next commands
```
make prep
vi msg
make commit
```
will carry out the desired outcome.
The first generates a file called `msg` that contains all the changes that
will be part of the commit.
Edit the file to the desired format, and issue the last command to carry out
the commit.
Note that:
1. `make prep` runs the code style checker automatically;
2. these commands will commit all changes to the repo, using the commit message
in `msg'. Finer control is offered by `scripts/prep-commit` and
`scripts/do-commit`. You may run git commands directly, too -- your choice;
just keep in mind to conform to the code style, and the commit message format.
Bug Reports
-----------
If you encounter a bug, please create an Issue at
[https://gitlab.com/astrop.mc/adm](https://gitlab.com/astrop.mc/adm).
Credits
=======
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment