We welcome and appreciate any contributions to this React project. Whether it's fixing a bug, improving performance, or adding new features, your help is valuable.
- Fork the repository and clone it to your local machine.
$ git clone https://github.com/YOUR_GITHUB_USERNAME/altcampv1-frontend.git
- Navigate to the project directory.
$ cd altcampv1-frontend
- Install the project dependencies.
$ npm install
- Copy the contents of
example.envto a new file called.envand fill in the required environment variables.
cp example.env .env
- Start the development server.
$ npm run dev
We expect all contributors to abide by our code of conduct. Please take a moment to read it before making any contributions.
Here are some ways you can contribute to the project:
If you find a bug while using the project, please report it by opening an issue on GitHub. Make sure to include a clear description of the problem, steps to reproduce it, and the expected behavior.
If you have an idea for a new feature or improvement, please open an issue on GitHub. Make sure to include a clear description of the problem, steps to reproduce it, and the expected behavior.
We use the Conventional Commits specifications to format our commit messages. Please read through the guide and follow the guidelines. If you're new to this format, that's okay. Here's a quick guide to get you started:
Commit CheatSheet
| Type | Description | |
|---|---|---|
| feat | Features | A new feature |
| fix | Bug Fixes | A bug fix |
| docs | Documentation | Documentation only changes |
| style | Styles | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) |
| refactor | Code Refactoring | A code change that neither fixes a bug nor adds a feature |
| perf | Performance Improvements | A code change that improves performance |
| test | Tests | Adding missing tests or correcting existing tests |
| build | Builds | Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) |
| ci | Continuous Integrations | Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs) |
| chore | Chores | Other changes that don't modify src or test files |
| revert | Reverts | Reverts a previous commit |
- Please format your commit messages appropriately:
- Use the body to explain what and why vs. how.
- Be as descriptive as possible in the 72 characters allowed. This helps us a lot when writing release notes and tracking down regressions. Here are some examples:
- Instead of
Fixing bugs, considerfix #1372: negative top/skip values would break odata output. - Instead of
Updating readme, considerimprove: making build instructions clearer in README. - Instead of
Adding some tests, considertest #889: missing test cases for permissions given anonymous user.
- Instead of
- Please do not use the
--amendflag when committing. This will cause your commit to be overwritten and will cause problems with the commit history.
If you're comfortable with Git and would like to contribute code, you can submit a pull request (PR) for review. To do this:
- Fork the repository
- Create a new branch for your changes (e.g.
git checkout -b my-new-feature) - Make your changes and test them thoroughly
- Commit your changes with a clear and descriptive commit message (e.g.
git commit -am 'Add new feature to improve XYZ') - Push your changes to your fork (e.g.
git push origin my-new-feature) - Create a new pull request
Please use TailwindCSS for styling and make sure to follow the CSS guidelines
We use a component-based architecture, so please make sure that any new features or improvements are implemented as a new component.
Once your pull request is submitted, it will be reviewed by one or more of the maintainers. We'll do our best to provide feedback and merge your changes as soon as possible.
Thank you for your contributions!
By contributing to this project, you agree that your contributions will be licensed under the project's LICENSE file.