Skip to content

Commit

Permalink
update README to include contribution and support giudelines
Browse files Browse the repository at this point in the history
  • Loading branch information
LeeoBianchi committed Apr 15, 2024
1 parent 8e5d91b commit 0e38b16
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,3 +116,13 @@ To run a code on multiple nodes, specify a machine file `machines.txt` as
````shell
$ mpiexec -machinefile machines.txt julia {your_script.jl}
````

## Support & Contributions

To seek support or to report bugs, please [open an issue](https://github.com/LeeoBianchi/HealpixMPI.jl/issues) on this repository.

If you would like to contribute to HealpixMPI.jl please describe first the problem you want to solve, or the idea you have, in a new issue.

After the issue is accepted you are good to go and can start writing code locally on your computer. Please remember to include **tests** and **documentation** for the new functionalities you are implementing.

Once your new code is ready, you can submit a new [pull request](https://github.com/LeeoBianchi/HealpixMPI.jl/pulls). Remember to check if the review of your pull request has yielded any comments, as they might require you to make changes to your code.

0 comments on commit 0e38b16

Please sign in to comment.